charturbo - v0.1.0
    Preparing search index...

    Interface AreaChartOptions

    Area chart: line options (2D only) plus the stacking mode and fill opacity.

    interface AreaChartOptions {
        animation?: ChartAnimationInput;
        axes?: {
            extraY?: ExtraYAxisOptions[];
            x?: LineXAxisOptions;
            y?: LineYAxisOptions;
            y2?: LineYAxisOptions;
        };
        decal?: ChartDecalInput;
        description?: string;
        fillOpacity?: number;
        grid?: ChartGridStyle;
        height?: number;
        hover?: ChartHoverStyle;
        legend?: boolean
        | ChartLegendOptions;
        lineWidth?: number;
        locale?: string;
        mode?: "stacked" | "percent" | "overlap";
        navigator?: NavigatorOption;
        nulls?: LineNullPolicy;
        padding?: ChartPaddingOptions;
        showBackdropGrid?: boolean;
        timeZone?: CharturboTimeZone;
        title?: string;
        width?: number;
        xLabelPrefix?: string;
    }

    Hierarchy

    Index
    animation? axes? decal? description? fillOpacity? grid? height? hover? legend? lineWidth? locale? mode? navigator? nulls? padding? showBackdropGrid? timeZone? title? width? xLabelPrefix?
    animation?: ChartAnimationInput

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

    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

    decal?: ChartDecalInput

    Pattern fills over the areas (accessibility, ECharts aria.decal): true gives each series 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)

    fillOpacity?: number

    Fill alpha multiplier of the series color (default: 0.2 overlap, 0.8 stacked / percent)

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

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

    legend?: boolean | ChartLegendOptions
    lineWidth?: number

    Stroke width in CSS pixels for every series; constant at any zoom (default: 2)

    locale?: string

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

    mode?: "stacked" | "percent" | "overlap"

    'overlap': every series filled down to zero (default). 'stacked': series stacked on each other. 'percent': stacked, each x normalized to 100%. Stacked modes need series of equal length (and identical x when given); NaN leaves a gap and counts as 0 for the series above.

    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.

    nulls?: LineNullPolicy

    Missing samples (NaN / null / undefined): 'gap' breaks the line / area (default), 'connect' joins the neighbours (stacked areas interpolate), 'zero' draws them at 0. Series nulls override it.

    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
    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