MAIDR JavaScript API
    Preparing search index...

    Interface EChartsList

    A series' data list.

    Addressed by index rather than iterated, which is what lets a reading walk it in the order the chart drew it.

    interface EChartsList {
        dimensions: string[];
        count: () => number;
        getName: (index: number) => string;
        get: (dimension: string, index: number) => number | null | undefined;
        mapDimension?: (coordinate: string) => string | undefined;
        mapDimensionsAll?: (coordinate: string) => string[];
        getItemLayout?: (index: number) => unknown;
        getLayout?: (key: string) => unknown;
        getItemVisual?: (index: number, key: string) => unknown;
        getVisual?: (key: string) => unknown;
        tree?: EChartsTree;
        graph?: EChartsGraph;
    }
    Index

    Properties

    dimensions count getName get mapDimension? mapDimensionsAll? getItemLayout? getLayout? getItemVisual? getVisual? tree? graph?

    Properties

    dimensions: string[]

    The column names, in order.

    count: () => number

    How many data points the series holds.

    getName: (index: number) => string

    The category name at index.

    Measured: the category axis' label on a category axis, and the empty string on a value axis -- so an empty name means "this axis carries numbers", not "this point is unnamed".

    get: (dimension: string, index: number) => number | null | undefined

    The value of one dimension at index.

    On a category axis this is the category's index, not its name; the name comes from getName.

    mapDimension?: (coordinate: string) => string | undefined

    The column one coordinate of the series reads -- 'x' to 'x' for data written inline, and the column encode names for data fed from a dataset, which carries every column of the dataset rather than only the ones the series is drawn from. undefined for a coordinate the series has none of. Optional because a hand-written list may lack it; dimension.ts falls back to the column's position.

    mapDimensionsAll?: (coordinate: string) => string[]

    Every column one coordinate of the series reads, in the order encode lists them -- a box plot maps five onto its value axis.

    getItemLayout?: (index: number) => unknown

    Where one datum was drawn, in the chart's CSS pixels. Its shape depends on the series type, and a datum with no value comes back with a null coordinate; canvas.ts records what was measured for each.

    getLayout?: (key: string) => unknown

    A layout of the whole series -- a line's 'points', flat [x0, y0, …].

    getItemVisual?: (index: number, key: string) => unknown

    One resolved visual of one datum -- its 'style', its 'symbolSize'.

    getVisual?: (key: string) => unknown

    One resolved visual of the whole series.

    tree?: EChartsTree

    The hierarchy, on a treemap, sunburst or tree series.

    graph?: EChartsGraph

    The graph, on a sankey or graph series.

    Settings

    Member Visibility

    On This Page

    Properties