This is the documentation of version 1.0.0-rc.2. Go to the latest version, 1.0.0-rc.5.

Type Alias CommonServiceParamsWithZoom

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

Common service parameters with zoom configuration.

Extended by GeometryDataParams and GeometryPlaceParams.

Type Declaration

Optionalzoom?: number

Optional zoom level for geometry detail.
Remarks
It 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
Align it with your map's current zoom level, and use a lower zoom for large geographies to reduce data size. Setting it is essential for performance with very large areas.
Default
```
undefined (returns highest detail available)
```
Minimum
0

Maximum
22
Example
```
zoom: 10  // City-level detail
zoom: 15  // Neighborhood-level detail
```