TomTom Maps for JavaScript
    Preparing search index...

    Type Alias CommonServiceParamsWithZoom

    CommonServiceParamsWithZoom: CommonServiceParams<URL, GeometryDataResponseAPI> & {
        zoom?: number;
    }

    Common service parameters with zoom configuration.

    Extended by GeometryDataParams and GeometryPlaceParams.

    Type Declaration

    • Optionalzoom?: number

      Optional zoom level for geometry detail.

      Controls the level of detail in the returned geometry:

      • Lower zoom (0-5): Simplified geometry for continents/countries
      • Medium zoom (6-12): Moderate detail for regions/cities
      • High zoom (13-22): Full detail for neighborhoods/buildings

      Recommendations:

      • Align with your map's current zoom level
      • Use lower zoom for large geographies to reduce data size
      • Essential for performance with very large areas
      undefined (returns highest detail available)
      

      0

      22

      zoom: 10  // City-level detail
      zoom: 15 // Neighborhood-level detail