charturbo - v0.1.0
    Preparing search index...

    Interface ComboSeriesDescriptor

    One combo series: one value per category / x (NaN / null = missing).

    interface ComboSeriesDescriptor {
        band?: LineBandOptions;
        color?: ColorInput;
        curve?: LineCurve;
        dash?: number[];
        lineWidth?: number;
        marker?: boolean | LineMarkerOptions;
        name: string;
        nulls?: LineNullPolicy;
        pieces?: LinePiece[];
        piecesBy?: "x" | "y";
        pointSize?: number;
        type: ComboSeriesType;
        values: number[] | Float32Array<ArrayBufferLike>;
        yAxis?: "left" | "right";
        yAxisIndex?: number;
    }

    Hierarchy (View Summary)

    Index
    band? color? curve? dash? lineWidth? marker? name nulls? pieces? piecesBy? pointSize? type values yAxis? yAxisIndex?
    band?: LineBandOptions
    color?: ColorInput

    Default: theme palette in series order

    curve?: LineCurve
    dash?: number[]

    CSS-px dash lengths [on, off] or [on, off, on, off] ([a] = [a, a]); empty = solid

    lineWidth?: number

    Stroke width of line / area series in CSS px (default: ComboChartOptions.lineWidth, 2)

    marker?: boolean | LineMarkerOptions
    name: string
    nulls?: LineNullPolicy
    pieces?: LinePiece[]

    Piecewise colors: the stroke, area fill, markers and tooltip swatch take the color of the first piece containing the value (outside every piece: the series color), switching exactly where the drawn line crosses a bound

    piecesBy?: "x" | "y"

    Value the pieces test: 'y' (default; area fills are banded by height) or 'x' (data x, epoch ms on a time axis, or the sample index without x)

    pointSize?: number

    Deprecated alias of marker: { size }

    type: ComboSeriesType

    'bar', 'line', or 'area' (a line filled down to zero, translucent)

    values: number[] | Float32Array<ArrayBufferLike>
    yAxis?: "left" | "right"

    y axis of this series (default 'left'). Any 'right' series adds a second y axis with its own domain and ticks (axes.y2); gridlines follow the left axis. Every bar series shares the first bar series' axis (bars stack / group on one scale).

    yAxisIndex?: number

    y axis index (overrides yAxis): 0 = axes.y, 1 = axes.y2, 2.. = axes.extraY[k - 2].

    Settings
    Member Visibility

    On This Page
    Properties