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

    Type Alias POI

    The Point of Interest (POI) details of a place such as a business, landmark or facility.

    They add operational details and categorization to the basic place information.

    const poi: POI = {
      name: 'Central Station Café',
      phone: '+31 20 123 4567',
      brands: ['Starbucks'],
      categories: ['CAFE'],
      localizedCategories: ['café'],
      url: 'https://example.com',
      openingHours: { mode: 'nextSevenDays', timeRanges: [...], alwaysOpenThisPeriod: false }
    };
    type POI = {
        brands?: string[];
        categories: POICategory[];
        localizedCategories: string[];
        name: string;
        openingHours?: OpeningHours;
        phone?: string;
        timeZone?: TimeZone;
        url?: string;
    }
    Index
    brands? categories localizedCategories name openingHours? phone? timeZone? url?
    brands?: string[]

    The brand names of this POI, such as 'Starbucks', 'Shell' or 'Marriott' for chain locations.

    categories: POICategory[]

    The standardized category identifiers of the POI.

    They are machine-readable names from the POICategory enum, such as 'ITALIAN_RESTAURANT', 'FUEL_STATION' or 'HOTEL', parsed from the numeric category IDs the API returns. Use them for filtering, programmatic category matching or mapping to icons.

    localizedCategories: string[]

    The localized, human-readable category names of the POI, as the API returns them.

    They are language-sensitive descriptions, such as 'italian', 'restaurant', 'gas station' or 'hotel', to display in the UI.

    name: string

    The primary display name of the POI, localized in the request language.

    openingHours?: OpeningHours

    When the POI is open, including daily schedules and special hours.

    Use it to tell whether a location is currently open, or to plan visits.

    phone?: string

    The contact phone number of the POI, typically with the country code, such as '+31 20 123 4567'.

    timeZone?: TimeZone

    The time zone of the POI location, for interpreting opening hours and scheduling visits across time zones.

    url?: string

    The URL of the official website or online presence of the business or location.

    Settings
    Member Visibility

    On This Page
    Properties