TomTom Maps SDK for JavaScript
This is the documentation of version 0.62.1. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias PlaceDetailsOptionalParams

    Optional parameters for the place details service.

    type PlaceDetailsOptionalParams = {
        geopoliticalView?: GeopoliticalView;
        mapcodes?: MapcodeType[];
        openingHours?: OpeningHoursMode;
        relatedPois?: RelatedPoisRequest;
        timeZone?: TimeZoneRequest;
    }
    Index
    geopoliticalView? mapcodes? openingHours? relatedPois? timeZone?
    geopoliticalView?: GeopoliticalView

    Geopolitical view of the result, overriding the global one: which country a place in a disputed territory belongs to. See GeopoliticalView.

    mapcodes?: MapcodeType[]

    Enable comma-separated mapcodes list in the response.

    Mapcodes are short location codes representing a specific location to within a few meters. Can filter to show only selected mapcode types.

    Mapcode Types:

    • Local: Short local codes for use within a territory
    • International: Longer codes that work worldwide
    • Alternative: Alternative codes for the same location

    Mapcode Project

    mapcodes: ['Local', 'International']
    openingHours?: OpeningHoursMode

    Include opening hours information in the response.

    Provides operating hours for POIs (restaurants, stores, etc.).

    openingHours: 'nextSevenDays'
    relatedPois?: RelatedPoisRequest

    Include related Points of Interest in the response.

    POIs can have parent/child relationships. For example, an airport terminal is a child of the airport.

    Relation Types:

    • child: Return POIs that are children of this place
    • parent: Return POIs that are parents of this place
    • all: Return both child and parent relations
    • off: No related POIs (default)
    'off'

    relatedPois: 'child'  // Get terminals inside an airport
    relatedPois: 'parent'  // Get the airport containing a terminal
    relatedPois: 'all'  // Get all related POIs
    timeZone?: TimeZoneRequest

    Include timezone information in the response.

    Returns the timezone of the place's location (e.g., "America/New_York").

    timeZone: 'iana'

    Settings
    Member Visibility

    On This Page
    Properties