charturbo - v0.1.0
    Preparing search index...

    Interface BandChartOptions

    interface BandChartOptions {
        axes?: {
            extraY?: ExtraYAxisOptions[];
            x?: LineXAxisOptions;
            y?: LineYAxisOptions;
            y2?: LineYAxisOptions;
        };
        connectNulls?: boolean;
        description?: string;
        endLabel?: boolean
        | LineEndLabelOptions;
        fillOpacity?: number;
        grid?: ChartGridStyle;
        height?: number;
        hover?: ChartHoverStyle;
        legend?: boolean | ChartLegendOptions;
        locale?: string;
        lowerLineWidth?: number;
        navigator?: NavigatorOption;
        padding?: ChartPaddingOptions;
        showBackdropGrid?: boolean;
        timeZone?: CharturboTimeZone;
        title?: string;
        upperLineWidth?: number;
        width?: number;
        xLabelPrefix?: string;
    }

    Hierarchy

    • Omit<LineChartOptions, "viewMode" | "lineWidth" | "nulls" | "animation">
      • BandChartOptions
    Index
    axes? connectNulls? description? endLabel? fillOpacity? grid? height? hover? legend? locale? lowerLineWidth? navigator? padding? showBackdropGrid? timeZone? title? upperLineWidth? width? xLabelPrefix?
    axes?: {
        extraY?: ExtraYAxisOptions[];
        x?: LineXAxisOptions;
        y?: LineYAxisOptions;
        y2?: LineYAxisOptions;
    }

    y2: right y axis, used only when a series has yAxis: 'right' / yAxisIndex: 1 (line charts). extraY: more y axes (axis k >= 2 = extraY[k - 2], at most 6) bound by series yAxisIndex, each with its own domain / scale / format / breaks, stacked beside the plot

    connectNulls?: boolean
    description?: string

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

    endLabel?: boolean | LineEndLabelOptions

    Line race label (2D line charts): series name + value beside the end of each visible line, riding the left -> right enter reveal (animation). true or { format }; reserves room on the right

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

    Hover layer style (crosshair, point markers). See ChartHoverStyle.

    legend?: boolean | ChartLegendOptions
    locale?: string

    Locale of this chart's default number / time labels and tooltip values (Intl); default: the SDK locale (setLocale), else the runtime locale

    lowerLineWidth?: number
    navigator?: NavigatorOption

    Range selector strip below the plot (2D only): an overview of every visible series over the full x range with a draggable / resizable zoom window (click outside it to jump, wheel to zoom). true or { height } in CSS px (default 48). Emits 'rangechange' like zoom / pan.

    padding?: ChartPaddingOptions
    showBackdropGrid?: boolean

    Horizontal gridlines + baseline (default: true). See grid for styling.

    timeZone?: CharturboTimeZone

    Time zone of a time x axis: tick boundaries (midnight, month start, hours on DST days) and labels / tooltips / a11y text / CSV (default: the SDK zone, setTimeZone, else 'local')

    title?: string
    upperLineWidth?: number
    width?: number
    xLabelPrefix?: string

    Prefix of the default x tick / tooltip label without series x, e.g. T -> T+120

    Settings
    Member Visibility

    On This Page
    Properties