MAIDR JavaScript API
    Preparing search index...

    Interface ChartObject

    One thing the object list can take the reader to.

    interface ChartObject {
        key: string;
        label: string;
        value?: ObjectValue;
        detail?: string;
        row: number;
        col: number;
        measures: Readonly<Record<string, number>>;
        groups: readonly string[];
    }
    Index

    Properties

    key: string

    Identity within the layer, taken from the data rather than from where the object sits -- a node's name, a tile's path -- so it survives sorting, filtering, a change of language and a rebuild of the chart. The trace finds the object again by this when it is chosen, so a chart that changed under an open list never sends the reader somewhere else.

    label: string

    What the object is called, as its announcement names it.

    value?: ObjectValue

    Its value, when it has one the announcement gives.

    detail?: string

    What else the list says about it, in the reader's language: "Links: 5".

    row: number

    The cell the cursor is taken to.

    col: number
    measures: Readonly<Record<string, number>>

    Numeric properties, by the id of an ObjectMeasure. A missing or non-finite value is unknown, and sorts last whichever way the list runs.

    groups: readonly string[]

    The ids of the filters it belongs to.