TomTom Maps for JavaScript
    Preparing search index...

    Type Alias POICategoryResult

    A single POI category entry returned by the POI categories service.

    type POICategoryResult = {
        childCategoryCodes: POICategory[];
        code: POICategory;
        name: string;
        synonyms: string[];
    }
    Index

    Properties

    childCategoryCodes: POICategory[]

    Codes of sub-categories that also matched the current filter result set.

    Only contains codes present in the filtered result set — not the full list of possible sub-categories — so you can understand the category hierarchy without additional lookups.

    Use these values directly in search poiCategories parameters.

    The standardized enum value identifying this category.

    Use this value in search poiCategories parameters to filter results by category, or to cross-reference with Place.properties.poi.categories on search results.

    name: string

    Human-readable category name in the requested language.

    synonyms: string[]

    Alternative names and synonyms for this category in the requested language.