charturbo - v0.1.0
    Preparing search index...

    Interface OhlcChartOptions

    interface OhlcChartOptions {
        animation?: ChartAnimationInput;
        axes?: { x?: LineXAxisOptions; y?: ChartAxisOptions };
        description?: string;
        downColor?: ColorInput;
        grid?: ChartGridStyle;
        height?: number;
        hover?: ChartHoverStyle;
        lineWidth?: number;
        locale?: string;
        padding?: ChartPaddingOptions;
        showBackdropGrid?: boolean;
        showVolume?: boolean;
        tickWidth?: number;
        timeZone?: CharturboTimeZone;
        title?: string;
        upColor?: ColorInput;
        volumeHeight?: number;
        volumeOpacity?: number;
        width?: number;
        yFit?: "all" | "visible";
    }

    Hierarchy

    • Omit<
          CandlestickChartOptions,
          "hollowUp"
          | "wickWidth"
          | "bodyWidth"
          | "cornerRadius",
      >
      • OhlcChartOptions
    Index
    animation? axes? description? downColor? grid? height? hover? lineWidth? locale? padding? showBackdropGrid? showVolume? tickWidth? timeZone? title? upColor? volumeHeight? volumeOpacity? width? yFit?
    animation?: ChartAnimationInput

    Enter / update animation of this chart (default: the SDK setting, setAnimation)

    axes?: { x?: LineXAxisOptions; y?: ChartAxisOptions }

    x.type defaults to 'time' when t is given (epoch ms / Date)

    description?: string

    Accessible name of the canvas; replaces the auto summary (which moves to the description)

    downColor?: ColorInput

    Falling candle color (default: theme palette[1], orange). Blue / orange stay distinct under color-vision deficiency

    grid?: ChartGridStyle
    height?: number
    hover?: ChartHoverStyle

    Crosshair style (vertical at the candle, horizontal at the pointer)

    lineWidth?: number

    Stem and tick stroke width in CSS px (0.25–8; default 1).

    locale?: string

    Locale of default labels / tooltip values (default: the SDK locale)

    padding?: ChartPaddingOptions
    showBackdropGrid?: boolean
    showVolume?: boolean

    Volume pane when volume is given (default: true)

    tickWidth?: number

    Combined left/right tick span as a fraction of bar spacing (0.05–1; default 0.7).

    timeZone?: CharturboTimeZone

    Time zone of the time axis and its labels (default: the SDK zone, setTimeZone)

    title?: string
    upColor?: ColorInput

    Rising candle color (close >= open; default: theme palette[0], blue)

    volumeHeight?: number

    Volume pane height as a fraction of the plot (default: 0.2)

    volumeOpacity?: number

    Volume bar opacity (default: 0.45)

    width?: number

    World size of the plot (aspect ratio of the framed plot; default: 168 x 86)

    yFit?: "all" | "visible"

    'visible': the price axis fits the visible candles on zoom / pan (default); 'all': every candle

    Settings
    Member Visibility

    On This Page
    Properties