TomTom Maps for JavaScript
    Preparing search index...

    Type Alias StateDigest

    A compact, diffable snapshot of the user-visible parts of ToolState. Every field serialises to JSON. Each call builds new arrays, so compare two digests with formatStateDigestDiff, not ===.

    type StateDigest = {
        byod: {
            datasetCount: number;
            datasetMode: DatasetMode;
            shown: string[];
        };
        customGeometries: {
            datasetCount: number;
            datasetMode: DatasetMode;
            shown: string[];
        };
        incidents: {
            datasetMode: DatasetMode;
            monitored: string[];
            shown: string[];
        };
        places: {
            datasetMode: DatasetMode;
            shownAsBaseMap: string[];
            shownAsPin: string[];
        };
        ranges: { datasetMode: DatasetMode; shown: string[] };
        routes: { datasetMode: DatasetMode; shown: string[] };
        traffic: {
            datasetCount: number;
            datasetMode: DatasetMode;
            shown: string[];
        };
    }
    Index
    byod: { datasetCount: number; datasetMode: DatasetMode; shown: string[] }

    Type Declaration

    • datasetCount: number

      Total BYOD datasets in history (shown + hidden).

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • shown: string[]

      BYOD dataset ids currently rendered on the map, sorted ascending.

    customGeometries: {
        datasetCount: number;
        datasetMode: DatasetMode;
        shown: string[];
    }

    Type Declaration

    • datasetCount: number

      Total custom-geometries datasets in history (shown + hidden).

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • shown: string[]

      Custom-geometries dataset ids currently rendered on the map, sorted ascending.

    incidents: { datasetMode: DatasetMode; monitored: string[]; shown: string[] }

    Type Declaration

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • monitored: string[]

      Dataset ids currently being polled by the per-dataset network monitor, sorted ascending.

    • shown: string[]

      Traffic-incidents dataset ids currently rendered on the map, sorted ascending.

    places: {
        datasetMode: DatasetMode;
        shownAsBaseMap: string[];
        shownAsPin: string[];
    }

    Type Declaration

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • shownAsBaseMap: string[]

      Dataset ids currently rendered as base-map POIs, sorted ascending.

    • shownAsPin: string[]

      Dataset ids currently rendered as individual pins, sorted ascending.

    ranges: { datasetMode: DatasetMode; shown: string[] }

    Type Declaration

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • shown: string[]

      Range-dataset ids currently drawn on the map, sorted ascending.

    routes: { datasetMode: DatasetMode; shown: string[] }

    Type Declaration

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • shown: string[]

      Routes-dataset ids currently drawn on the map, sorted ascending.

    traffic: { datasetCount: number; datasetMode: DatasetMode; shown: string[] }

    Type Declaration

    • datasetCount: number

      Total traffic-area-analytics datasets in history (shown + hidden).

    • datasetMode: DatasetMode

      The slice's display policy, multiple (default) or single.

    • shown: string[]

      Traffic-area-analytics dataset ids currently rendered on the map, sorted ascending.