charturbo - v0.1.0
    Preparing search index...

    Interface PictorialBarChartOptions

    Bar chart options (2D only; mode / groupGap / barGap apply to series data) plus symbol defaults.

    interface PictorialBarChartOptions {
        animation?: ChartAnimationInput;
        axes?: {
            x?: ChartAxisOptions & ChartAxisBreakOptions;
            y?: ChartAxisOptions & ChartAxisBreakOptions;
        };
        background?: boolean
        | BarBackgroundOptions;
        barGap?: number;
        barThickness?: number;
        color?: ColorInput;
        cornerRadius?: number;
        decal?: ChartDecalInput;
        description?: string;
        errorBars?: BarErrorBarStyle;
        grid?: ChartGridStyle;
        groupGap?: number;
        hover?: ChartHoverStyle;
        labels?: boolean | "auto" | BarLabelOptions;
        legend?: boolean | ChartLegendOptions;
        maxBarHeight?: number;
        mode?: "grouped" | "stacked" | "percent";
        orientation?: BarOrientation;
        padding?: ChartPaddingOptions;
        realtimeSort?: boolean | BarRealtimeSortOptions;
        seriesName?: string;
        symbol?: PictorialSymbol;
        symbolBoundingData?: number | readonly [number, number];
        symbolClip?: boolean;
        symbolMargin?: PictorialLength | `${number}!` | `${number}%!`;
        symbolOffset?:
            | PictorialLength
            | readonly [PictorialLength, PictorialLength];
        symbolPosition?: "center" | "end" | "start";
        symbolRepeat?: number | boolean | "fixed";
        symbolRotate?: number;
        symbolSize?: PictorialLength | readonly [PictorialLength, PictorialLength];
        title?: string;
        viewMode?: "2d" | "3d";
        width?: number;
    }

    Hierarchy (View Summary)

    Index

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

    breaks apply to the value axis only (axes.y; horizontal bars: axes.x; 2D)

    background?: boolean | BarBackgroundOptions

    Background tracks behind the bars, across the whole value axis (2D): true for the theme default or a color / opacity. Grouped bars get one per bar slot (hidden series drop theirs), stacked / percent bars one per category. Not hover targets

    barGap?: number

    CSS pixels between the bars of a group / between stacked segments (default: 2)

    barThickness?: number

    Bar width in world units (default: 72% of the slot)

    color?: ColorInput

    Default bar color when an item has none (default: first palette color)

    cornerRadius?: number

    Radius of the rounded data-end corners in CSS pixels, 2D only (default: 4)

    Pattern fills over the bars (2D, not pictorial bars) (accessibility, ECharts aria.decal): true gives each series (single series: each item category) its own automatic pattern; options apply over the automatic patterns (default off).

    description?: string

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

    errorBars?: BarErrorBarStyle

    Look of error bars (values come from error on items / series)

    groupGap?: number

    Empty fraction of each category slot between groups (default: 0.28; ignored with barThickness)

    Hover style (barHighlightColor). See ChartHoverStyle.

    labels?: boolean | "auto" | BarLabelOptions

    Data labels on the bars: true, 'auto' (hide what does not fit / collides) or options (2D)

    legend?: boolean | ChartLegendOptions

    Legend. Multi-series: series toggle (re-stacks) / hover emphasis, shown for 2+ series in 2D. Single series (on request, static): a key of the item category values (color of each category's first bar) when items have categories, else one entry named seriesName

    maxBarHeight?: number
    mode?: "grouped" | "stacked" | "percent"

    'grouped': series side by side in each category (default). 'stacked': positive values stack up and negative values stack down. 'percent': stacked, each category normalized to 100%.

    orientation?: BarOrientation

    'horizontal': categories down the left axis, bars growing right (negative values left); axes.x is then the value axis and axes.y the category axis. 2D only (default 'vertical')

    realtimeSort?: boolean | BarRealtimeSortOptions

    Bar race (single-series 2D bars): bars are sorted by value (largest first: left, or top when horizontal) and, re-rendered with new values and animation on, slide to their new rank by label while category labels ride along and data labels count up. { max } keeps the largest max bars (bars entering / leaving fade). The value axis takes the new domain at once

    seriesName?: string

    Single-series charts: series name of the legend entry (default: 'Value' in the chart language)

    Default 'circle'. path:// paths are scaled to the symbol box (aspect not kept)

    symbolBoundingData?: number | readonly [number, number]

    Value the symbols are laid out against instead of the bar value: one value, or [negative, positive] bounds for negative / positive bars

    symbolClip?: boolean

    Clip the symbols at the data value (default false)

    symbolMargin?: PictorialLength | `${number}!` | `${number}%!`

    Gap on each side of a repeated symbol, px or percent of its value-axis size (default '15%'); the gaps are re-spread so the run fills its length. A trailing ! ('10%!') keeps gaps at both ends of the run too

    symbolOffset?: PictorialLength | readonly [PictorialLength, PictorialLength]

    Screen [right, down] offset, px or percent of the symbol size; one value for both

    symbolPosition?: "center" | "end" | "start"

    Where a single symbol / the repeated run sits along the bar (default 'start')

    symbolRepeat?: number | boolean | "fixed"

    false (default): one symbol. true: repeated over the bar length. A number: that many. 'fixed': as many as fit the bounding length (plot edge / symbolBoundingData), whatever the value (combine with symbolClip for a "fill level" look)

    symbolRotate?: number

    Rotation in degrees, positive = anticlockwise (default 0)

    [width, height] on screen, or one value for both (default ['100%', '100%']). Percents: of the bar thickness on the category axis; on the value axis of the bar length (or of the symbolBoundingData length), or of the bar thickness when repeating

    title?: string
    viewMode?: "2d" | "3d"
    width?: number