MAIDR JavaScript API
    Preparing search index...

    Interface NavMap

    Resolves a MAIDR navigation position to the am5 targets to highlight.

    interface NavMap {
        resolve: (
            layerId: string,
            row: number,
            col: number,
            pointIndices?: readonly number[],
        ) => NavTarget[];
        chartFor: (layerId: string) => AmChart | undefined;
        chartCount: number;
    }
    Index

    Properties

    resolve chartFor chartCount

    Properties

    resolve: (
        layerId: string,
        row: number,
        col: number,
        pointIndices?: readonly number[],
    ) => NavTarget[]

    Type Declaration

      • (
            layerId: string,
            row: number,
            col: number,
            pointIndices?: readonly number[],
        ): NavTarget[]

      • Parameters

        • layerId: string

          The layer the position belongs to

        • row: number

          The MAIDR row, or -1 when pointIndices is given

        • col: number

          The MAIDR column, or -1 when pointIndices is given

        • OptionalpointIndices: readonly number[]

          For a layer that names its own marks, the layer.data indices to outline. A cloud's selection is a set of points that no row/column pair can name, and a flow or network position names a node rather than the ribbon drawn for it, so both are addressed by data index instead.

        Returns NavTarget[]

    chartFor: (layerId: string) => AmChart | undefined

    The chart owning a layer, so highlights can be clipped against the owning panel's plot bounds. Layer ids are unique figure-wide, so the id alone disambiguates the panel.

    chartCount: number

    Number of distinct charts (panels) in the map.

    Settings

    Member Visibility

    On This Page

    Properties