TomTom Maps for JavaScript
    Preparing search index...

    Type Alias PlacesEntry

    A single entry in the place search history.

    type PlacesEntry = {
        _analysis?: PlacesAnalysis[];
        _byId?: Record<string, Place>;
        _geometryByPlaceId?: Record<string, PolygonFeature<CommonPlaceProps>>;
        _modules?: { geometries?: GeometriesModule; places?: PlacesModule };
        _shownAs?: "pin" | "base-map" | "pin-clustered";
        connections?: PlaceConnectionDisplay[];
        geometries?: PolygonFeature<CommonPlaceProps>[];
        id: string;
        label: string;
        places: Place[];
        timestamp: number;
    }
    Index

    Properties

    _analysis? _byId? _geometryByPlaceId? _modules? _shownAs? connections? geometries? id label places timestamp

    Properties

    Optional_analysis

    _analysis?: PlacesAnalysis[]

    Accumulated analysis results linked to this entry.

    Optional_byId

    _byId?: Record<string, Place>

    Lazy place-id → Place index, built on first ID lookup through PlacesState.findPlaceById.

    Optional_geometryByPlaceId

    _geometryByPlaceId?: Record<string, PolygonFeature<CommonPlaceProps>>

    Lazy place-id → boundary polygon index, built on first lookup through PlacesState.getGeometryForPlace.

    Optional_modules

    _modules?: { geometries?: GeometriesModule; places?: PlacesModule }

    Per-entry display modules. An entry is rendered under at most one marker theme at a time, so a single PlacesModule covers all themes — _showEntryAs rethemes it via applyTheme. A dedicated GeometriesModule renders the entry's boundary polygons. Lazy-initialised via PlacesState helpers — undefined until first show.

    Optional_shownAs

    _shownAs?: "pin" | "base-map" | "pin-clustered"

    The marker theme currently rendering this entry, or undefined when hidden.

    connections?: PlaceConnectionDisplay[]

    Connections (lines between places) produced alongside this entry, rendered via PlacesModule.showConnections.

    geometries?: PolygonFeature<CommonPlaceProps>[]

    Boundary polygons attached to this entry. One feature per place that has a geometry data source (populated lazily via PlacesState.fetchPlaceGeometry), or a standalone result list produced by tools like processData. Each feature's id is the geometry-data-source id (place.properties.dataSources.geometry.id), matching the response shape of geometryData.

    id: string
    label: string
    places: Place[]
    timestamp: number

    Settings

    Member Visibility

    On This Page

    Properties