TomTom Maps for JavaScript
    Preparing search index...

    Type Alias StateDigest

    Compact snapshot of the user-visible parts of ToolState. Designed to be diffable: every field is serialisable to JSON and stable for === comparison when the underlying state hasn't changed.

    type StateDigest = {
        byod: { entryCount: number; entryMode: EntryMode; shown: string[] };
        customGeometries: {
            entryCount: number;
            entryMode: EntryMode;
            shown: string[];
        };
        incidents: { entryMode: EntryMode; monitored: string[]; shown: string[] };
        places: {
            entryMode: EntryMode;
            shownAsBaseMap: string[];
            shownAsPin: string[];
        };
        ranges: { entryMode: EntryMode; shown: string[] };
        routes: { entryMode: EntryMode; shown: string[] };
        traffic: { entryCount: number; entryMode: EntryMode; shown: string[] };
    }
    Index

    Properties

    byod customGeometries incidents places ranges routes traffic

    Properties

    byod: { entryCount: number; entryMode: EntryMode; shown: string[] }

    Type Declaration

    • entryCount: number

      Total BYOD entries in history (shown + hidden).

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • shown: string[]

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

    customGeometries: { entryCount: number; entryMode: EntryMode; shown: string[] }

    Type Declaration

    • entryCount: number

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

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • shown: string[]

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

    incidents: { entryMode: EntryMode; monitored: string[]; shown: string[] }

    Type Declaration

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • monitored: string[]

      Entry ids currently being polled by the per-entry network monitor, sorted ascending.

    • shown: string[]

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

    places: { entryMode: EntryMode; shownAsBaseMap: string[]; shownAsPin: string[] }

    Type Declaration

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • shownAsBaseMap: string[]

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

    • shownAsPin: string[]

      Entry ids currently rendered as individual pins, sorted ascending.

    ranges: { entryMode: EntryMode; shown: string[] }

    Type Declaration

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • shown: string[]

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

    routes: { entryMode: EntryMode; shown: string[] }

    Type Declaration

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • shown: string[]

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

    traffic: { entryCount: number; entryMode: EntryMode; shown: string[] }

    Type Declaration

    • entryCount: number

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

    • entryMode: EntryMode

      Display policy in force on the slice — multiple (default) or single.

    • shown: string[]

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

    Settings

    Member Visibility

    On This Page

    Properties