charturbo - v0.1.0
    Preparing search index...

    Interface WaterfallChartOptions

    interface WaterfallChartOptions {
        axes?: { x?: ChartAxisOptions; y?: ChartAxisOptions };
        colors?: {
            connector?: ColorInput;
            decrease?: ColorInput;
            increase?: ColorInput;
            total?: ColorInput;
        };
        connectors?: boolean;
        cornerRadius?: number;
        description?: string;
        format?: ChartValueFormat;
        grid?: ChartGridStyle;
        hover?: ChartHoverStyle;
        labels?: boolean
        | "auto"
        | Omit<BarLabelOptions, "format">;
        legend?: boolean | ChartLegendOptions;
        names?: { decrease?: string; increase?: string; total?: string };
        orientation?: BarOrientation;
        padding?: ChartPaddingOptions;
        showBackdropGrid?: boolean;
        title?: string;
        total?: string | boolean;
        valueLabel?: string;
    }
    Index
    axes? colors? connectors? cornerRadius? description? format? grid? hover? labels? legend? names? orientation? padding? showBackdropGrid? title? total? valueLabel?
    axes?: { x?: ChartAxisOptions; y?: ChartAxisOptions }
    colors?: {
        connector?: ColorInput;
        decrease?: ColorInput;
        increase?: ColorInput;
        total?: ColorInput;
    }

    Colors (default: first / second palette slots and the theme's neutral baseline color)

    connectors?: boolean

    Dashed lines from each bar's end level to the next bar (default: true)

    cornerRadius?: number

    Data-end corner radius in CSS px (default 0)

    description?: string

    Accessible name of the canvas

    format?: ChartValueFormat

    Value text of labels, tooltip and a11y (spec, Intl options or function; default: locale number)

    grid?: ChartGridStyle
    hover?: ChartHoverStyle

    Hovered bar highlight

    labels?: boolean | "auto" | Omit<BarLabelOptions, "format">

    Value labels: 'auto' (default: hidden where they collide), true, false, or bar label options. Changes carry their sign (+1,200, −300); totals show the running total

    legend?: boolean | ChartLegendOptions

    Legend of the kinds present (default: shown with 2+ kinds; static)

    names?: { decrease?: string; increase?: string; total?: string }

    Legend / tooltip names of the kinds (default: Increase / Decrease / Total in the chart locale)

    orientation?: BarOrientation

    'vertical' (default) or 'horizontal' (categories down the left axis)

    padding?: ChartPaddingOptions
    showBackdropGrid?: boolean

    Value gridlines + baseline (default: true)

    title?: string
    total?: string | boolean

    Appends a final total bar: true (named 'Total' in the chart locale) or its name

    valueLabel?: string

    Tooltip / table name of the changes (default: 'Change' in the chart locale)

    Settings
    Member Visibility

    On This Page
    Properties