charturbo - v0.1.0
    Preparing search index...

    Interface ChartTooltipContext

    interface ChartTooltipContext {
        areaMode?: "stacked" | "percent" | "overlap";
        box?: ChartBoxTooltip;
        calendar?: ChartCalendarTooltip;
        cell?: { col: number; row: number; xLabel: string; yLabel: string };
        chartType:
            | "bar"
            | "band"
            | "chord"
            | "line"
            | "scatter"
            | "heatmap"
            | "box"
            | "combo"
            | "tree"
            | "graph"
            | "parallel"
            | "polar"
            | "pointCloud3d"
            | "surface3d"
            | "errorBar"
            | "impulse"
            | "candlestick"
            | "ohlc"
            | "pie"
            | "radar"
            | "gauge"
            | "funnel"
            | "waterfall"
            | "treemap"
            | "sunburst"
            | "sankey"
            | "calendar"
            | "themeRiver";
        chord?: ChartChordTooltip;
        details: NodeDetails
        | null;
        flow?: ChartFlowTooltip;
        funnel?: ChartFunnelTooltip;
        gauge?: ChartGaugeTooltip;
        hierarchy?: ChartHierarchyTooltip;
        index: number;
        items: ChartTooltipItem[];
        ohlc?: ChartOhlc;
        parallel?: ChartParallelTooltip;
        point?: { x: number; y: number };
        point3d?: {
            column?: number;
            row?: number;
            x: number;
            y: number;
            z: number;
        };
        polar?: ChartPolarTooltip;
        radar?: ChartRadarTooltip;
        slice?: {
            label: string;
            members?: string[];
            percent: number;
            ring?: string;
            value: number;
        };
        total?: number;
        waterfall?: ChartWaterfallTooltip;
        x?: number;
        xLabel: string;
    }
    Index
    areaMode? box? calendar? cell? chartType chord? details flow? funnel? gauge? hierarchy? index items ohlc? parallel? point? point3d? polar? radar? slice? total? waterfall? x? xLabel
    areaMode?: "stacked" | "percent" | "overlap"

    Area charts (chartType: 'line'): stacking mode of the chart

    box?: ChartBoxTooltip

    Box plots: statistics of the hovered group (and the hovered outlier value)

    calendar?: ChartCalendarTooltip

    Hovered calendar day (empty days too: value NaN)

    cell?: { col: number; row: number; xLabel: string; yLabel: string }

    Hovered heatmap cell and its axis labels

    chartType:
        | "bar"
        | "band"
        | "chord"
        | "line"
        | "scatter"
        | "heatmap"
        | "box"
        | "combo"
        | "tree"
        | "graph"
        | "parallel"
        | "polar"
        | "pointCloud3d"
        | "surface3d"
        | "errorBar"
        | "impulse"
        | "candlestick"
        | "ohlc"
        | "pie"
        | "radar"
        | "gauge"
        | "funnel"
        | "waterfall"
        | "treemap"
        | "sunburst"
        | "sankey"
        | "calendar"
        | "themeRiver"

    'combo': bar / line / area series of a combo chart (items = every series at the category)

    chord?: ChartChordTooltip

    Hovered chord group (total) or ribbon (flow and the reverse flow)

    details: NodeDetails | null

    Full details of the primary hovered point (closest to the pointer)

    flow?: ChartFlowTooltip

    Hovered sankey link (A → B, share of A) or node (inflow / outflow)

    funnel?: ChartFunnelTooltip

    Hovered funnel stage and its conversion rates

    gauge?: ChartGaugeTooltip

    Gauge value, range and band

    hierarchy?: ChartHierarchyTooltip

    Hovered treemap / sunburst node: path, value, shares of its parent and of the total

    index: number

    Hovered sample / bar / point index (heatmap: column; box plot: category; pie: displayed slice; radar: axis; gauge: 0 = value, 1 + k = band; funnel: stage; waterfall: bar; treemap / sunburst: node; sankey: node or link)

    items: ChartTooltipItem[]

    One entry per series at the hovered x (line index mode, stacked bars) or the single hovered point / bar (nearest mode, single / grouped bars)

    ohlc?: ChartOhlc

    Candlestick charts: open / high / low / close / volume of the hovered candle or bucket

    parallel?: ChartParallelTooltip

    Hovered parallel coordinates row: every dimension

    point?: { x: number; y: number }

    Data coordinates of the hovered scatter point

    point3d?: { column?: number; row?: number; x: number; y: number; z: number }
    polar?: ChartPolarTooltip

    Hovered polar item: series, angle / radius coordinates and value

    radar?: ChartRadarTooltip

    Hovered radar axis

    slice?: {
        label: string;
        members?: string[];
        percent: number;
        ring?: string;
        value: number;
    }

    Hovered pie slice: share of the visible total (0-100); "Other" lists the folded names

    total?: number

    'stacked' bar / area charts: sum of every visible series at the hovered category / x

    waterfall?: ChartWaterfallTooltip

    Hovered waterfall bar: change and running totals

    x?: number

    Series x value of the primary hovered sample (line charts with x only)

    xLabel: string

    x-axis label for line charts (e.g. T+120 or the formatted x), bar / category label for bar charts, formatted x for scatter

    Settings
    Member Visibility

    On This Page
    Properties