This is the documentation of version 0.51.0. Go to the latest version, 1.0.0.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias PlaceByIdOptionalParams

    Optional parameters for the Place by ID service.

    type PlaceByIdOptionalParams = {
        mapcodes?: MapcodeType[];
        openingHours?: OpeningHoursMode;
        relatedPois?: RelatedPoisRequest;
        timeZone?: TimeZoneRequest;
        view?: View;
    }
    Index

    Properties

    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
    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'
    
    view?: View

    Geopolitical view context for disputed territories.

    Determines how disputed territories are handled in the response.

    Available Views:

    • Unified: International view (default)
    • AR: Argentina
    • IN: India
    • PK: Pakistan
    • IL: Israel
    • MA: Morocco
    • RU: Russia
    • TR: Turkey
    • CN: China
    'Unified'
    
    view: 'IN'  // Indian geopolitical view