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 POI

    Point of Interest (POI) information.

    Contains detailed information about a place such as a business, landmark, or facility. This data enriches basic place information with operational details and categorization.

    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

    Properties

    brands?: string[]

    Brand names associated with this POI.

    For chain locations, identifies the brand (e.g., 'Starbucks', 'Shell', 'Marriott').

    categories: POICategory[]

    Standardized category identifiers for the POI.

    Machine-readable category names from the POICategory enum (e.g., 'ITALIAN_RESTAURANT', 'GAS_STATION', 'HOTEL'). Use these for filtering, programmatic category matching, or mapping to icons. Parsed from the numeric category IDs returned by the API.

    localizedCategories: string[]

    Localized human-readable category names for the POI.

    Language-sensitive text descriptions of the POI categories as returned by the API (e.g., 'italian', 'restaurant', 'gas station', 'hotel'). Suitable for display in the UI.

    name: string

    Name of the point of interest.

    The primary display name, localized according to the request language.

    openingHours?: OpeningHours

    Operating hours information.

    Specifies when the POI is open, including daily schedules and special hours. Useful for determining if a location is currently open or planning visits.

    phone?: string

    Contact phone number for the POI.

    Typically includes country code (e.g., '+31 20 123 4567').

    timeZone?: TimeZone

    Time zone of the POI location.

    Used for interpreting opening hours and scheduling visits across time zones.

    url?: string

    Website URL for the POI.

    Official website or online presence for the business or location.