charturbo - v0.1.0
    Preparing search index...

    Interface SparklineOptions

    interface SparklineOptions {
        band?: [number, number];
        bandColor?: ColorInput;
        color?: ColorInput;
        description?: string;
        fillOpacity?: number;
        formatValue?: (v: number) => string;
        height?: number;
        label?: string;
        lastColor?: ColorInput;
        lineWidth?: number;
        markerRadius?: number;
        minMaxColor?: ColorInput;
        negativeColor?: ColorInput;
        padding?: number;
        showLast?: boolean;
        showMinMax?: boolean;
        tooltip?: boolean;
        type?: SparklineType;
        width?: number;
    }
    Index
    band? bandColor? color? description? fillOpacity? formatValue? height? label? lastColor? lineWidth? markerRadius? minMaxColor? negativeColor? padding? showLast? showMinMax? tooltip? type? width?
    band?: [number, number]

    Reference band [lo, hi] in data units (e.g. a target range), beneath the series

    bandColor?: ColorInput

    Band color (default: theme muted text color at 15% alpha); its alpha is used as is

    color?: ColorInput

    Series / bar / win color (default: first theme palette color)

    description?: string

    Accessible name of the canvas; replaces the generated trend summary

    fillOpacity?: number

    Area fill alpha multiplier (default 0.2)

    formatValue?: (v: number) => string

    Number format of the aria-label / tooltip values (default: locale, up to 2 decimals)

    height?: number
    label?: string

    Name used in the aria-label and tooltip, e.g. 'Revenue'

    lastColor?: ColorInput
    lineWidth?: number

    Stroke width in CSS px (default 1.5)

    markerRadius?: number

    Marker radius in CSS px (default 2.5)

    minMaxColor?: ColorInput

    Min / max marker color (default: theme secondary text color)

    negativeColor?: ColorInput

    Loss bars of 'winloss' (default: second theme palette color)

    padding?: number

    CSS px around the plot (default 2, or marker radius + 1 when markers are shown)

    showLast?: boolean

    Marker on the last sample, in the series color (default false)

    showMinMax?: boolean

    Markers on the minimum and maximum (default false; ignored by 'winloss')

    tooltip?: boolean

    Built-in hover tooltip (default false: no tooltip DOM, no pointer listeners)

    type?: SparklineType

    'line' (default), 'area', 'bar' or 'winloss' (equal up / down bars by sign)

    width?: number

    Plot size in world units; only the aspect matters (the plot fills the canvas). Default: the canvas CSS size minus padding — re-fitted on resize while neither is given.

    Settings
    Member Visibility

    On This Page
    Properties