TomTom Maps for JavaScript
    Preparing search index...

    Function geometryData

    • Retrieve polygon geometries representing geographic area boundaries.

      The Geometry Data service returns coordinate sets that define the outlines of geographic areas such as cities, countries, administrative regions, or POI footprints. These polygons enable visualization of area boundaries, spatial analysis, and geofencing applications.

      Parameters

      • params: GeometryDataParams

        Geometry parameters with IDs or places to fetch boundaries for

      • OptionalcustomTemplate: Partial<GeometryDataTemplate>

        Advanced customization for request/response handling

      Returns Promise<PolygonFeatures>

      Promise resolving to polygon features representing area boundaries

      Key features:

      • Batch requests: Fetch up to 20 geometries in a single call
      • Multiple scales: From countries down to building footprints
      • Place integration: Can merge with place data for enriched results
      • Standard GeoJSON: Returns standard Polygon/MultiPolygon features

      Common use cases:

      • Display city or country boundaries on maps
      • Show POI building footprints
      • Create geofences for spatial queries
      • Visualize administrative divisions
      • Calculate areas and spatial relationships
      // Fetch geometry by ID
      const cityBoundary = await geometryData({
      key: 'your-api-key',
      geometries: ['geometry-id-123']
      });

      // Fetch multiple geometries at once
      const boundaries = await geometryData({
      key: 'your-api-key',
      geometries: ['country-id-1', 'city-id-2', 'poi-id-3']
      });

      // Fetch and merge with place data
      const searchResults = await search({ query: 'Amsterdam' });
      const withBoundaries = await geometryData({
      key: 'your-api-key',
      geometries: searchResults // Places with geometry IDs
      });
      // Result includes both place properties and polygon boundaries
    • Retrieve polygon geometries representing geographic area boundaries.

      The Geometry Data service returns coordinate sets that define the outlines of geographic areas such as cities, countries, administrative regions, or POI footprints. These polygons enable visualization of area boundaries, spatial analysis, and geofencing applications.

      Parameters

      • params: GeometryPlaceParams

        Geometry parameters with IDs or places to fetch boundaries for

      • OptionalcustomTemplate: Partial<GeometryDataTemplate>

        Advanced customization for request/response handling

      Returns Promise<PolygonFeatures<CommonPlaceProps>>

      Promise resolving to polygon features representing area boundaries

      Key features:

      • Batch requests: Fetch up to 20 geometries in a single call
      • Multiple scales: From countries down to building footprints
      • Place integration: Can merge with place data for enriched results
      • Standard GeoJSON: Returns standard Polygon/MultiPolygon features

      Common use cases:

      • Display city or country boundaries on maps
      • Show POI building footprints
      • Create geofences for spatial queries
      • Visualize administrative divisions
      • Calculate areas and spatial relationships
      // Fetch geometry by ID
      const cityBoundary = await geometryData({
      key: 'your-api-key',
      geometries: ['geometry-id-123']
      });

      // Fetch multiple geometries at once
      const boundaries = await geometryData({
      key: 'your-api-key',
      geometries: ['country-id-1', 'city-id-2', 'poi-id-3']
      });

      // Fetch and merge with place data
      const searchResults = await search({ query: 'Amsterdam' });
      const withBoundaries = await geometryData({
      key: 'your-api-key',
      geometries: searchResults // Places with geometry IDs
      });
      // Result includes both place properties and polygon boundaries