TomTom Maps for JavaScript
    Preparing search index...

    Type Alias Places<P, FeatureCollectionProps>

    Places: Omit<
        FeatureCollectionWithProperties<Point, P, FeatureCollectionProps>,
        "features" | "bbox",
    > & { bbox?: BBox; features: Place<P>[] }

    GeoJSON FeatureCollection containing multiple places.

    Collection of place results from search or geocoding operations.

    Type Parameters

    • P extends CommonPlaceProps = CommonPlaceProps

      Type of individual place properties (defaults to CommonPlaceProps)

    • FeatureCollectionProps = unknown

      Type of collection-level properties

    Type Declaration

    • Optionalbbox?: BBox

      Bounding box that contains all the places, including their bounding boxes.

      • Only included if any places are present.
    • features: Place<P>[]

      Array of place features.

      • Each place has a required string ID.
    const places: Places<SearchPlaceProps> = {
    type: 'FeatureCollection',
    features: [
    { id: '1', type: 'Feature', geometry: {...}, properties: {...} },
    { id: '2', type: 'Feature', geometry: {...}, properties: {...} }
    ]
    };