meo-canvas - v9.0.2
    Preparing search index...

    Interface CartesianChartSpecificOptions<Item>

    Options only a chart with axes understands — bar and line.

    interface CartesianChartSpecificOptions<Item = ChartItem> {
        axisColor?: string;
        grid?: GridOptions;
        renderValueItem?: (
            props: { datasetIndex: number; index: number; item: number },
        ) => Item;
        showValues?: boolean;
        showYAxis?: boolean;
        valueColor?: string;
        valueFontSize?: number;
        xAxisLabelFormatter?: (value: string, index: number) => string;
        yAxisColor?: string;
        yAxisFontSize?: number;
        yAxisLabelFormatter?: (value: number) => string;
    }

    Type Parameters

    Index
    axisColor? grid? renderValueItem? showValues? showYAxis? valueColor? valueFontSize? xAxisLabelFormatter? yAxisColor? yAxisFontSize? yAxisLabelFormatter?
    axisColor?: string

    Colour of the axis lines. Accepts standard CSS colour strings.

    grid?: GridOptions

    The grid lines behind the plot — see GridOptions.

    undefined (no grid)
    renderValueItem?: (
        props: { datasetIndex: number; index: number; item: number },
    ) => Item

    Draws the value printed above one bar or point in place of the built-in one. datasetIndex says which series it belongs to. Return nothing to leave it out.

    showValues?: boolean

    Print each value above its bar or point.

    false
    showYAxis?: boolean

    Draw the value axis down the left of the plot.

    false
    valueColor?: string

    Colour of the printed values. Accepts standard CSS colour strings.

    valueFontSize?: number

    Size of the printed values.

    Pixels.

    12
    xAxisLabelFormatter?: (value: string, index: number) => string

    Rewrites each category-axis label before it is drawn. The index is its position along the axis, which is what lets every other one be dropped on a crowded chart.

    (label, index) => (index % 2 ? '' : label)
    yAxisColor?: string

    Colour of the value axis labels. Accepts standard CSS colour strings.

    yAxisFontSize?: number

    Size of the value axis labels.

    Pixels.

    12
    yAxisLabelFormatter?: (value: number) => string

    Rewrites each value-axis label before it is drawn — for a currency prefix, a unit, or a thousands separator.

    (value) => `$${value.toLocaleString()}`

    Settings
    Member Visibility

    On This Page
    Properties