Share via

SearchGetPolygonQueryParamProperties interface

  • Reference
Package:
@azure-rest/maps-search

Properties

coordinates

A point on the earth specified as a longitude and latitude. Example: &coordinates=lon,lat
resolution

Resolution determines the amount of points to send back. If not specified, the default is medium resolution.
resultType

The geopolitical concept to return a boundary for. If not specified, the default is countryRegion result type.
view

A string that represents an ISO 3166-1 Alpha-2 region/country code. This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to “Auto” even if you haven’t defined it in the request.

Please refer to Supported Views for details and to see the available Views.

Property Details

coordinates

A point on the earth specified as a longitude and latitude. Example: &coordinates=lon,lat

coordinates: number[]

Property Value

number[]

resolution

Resolution determines the amount of points to send back. If not specified, the default is medium resolution.

resolution?: "small" | "medium" | "large" | "huge"

Property Value

"small" | "medium" | "large" | "huge"

resultType

The geopolitical concept to return a boundary for. If not specified, the default is countryRegion result type.

resultType?: "countryRegion" | "adminDistrict" | "adminDistrict2" | "postalCode" | "postalCode2" | "postalCode3" | "postalCode4" | "neighborhood" | "locality"

Property Value

"countryRegion" | "adminDistrict" | "adminDistrict2" | "postalCode" | "postalCode2" | "postalCode3" | "postalCode4" | "neighborhood" | "locality"

view

A string that represents an ISO 3166-1 Alpha-2 region/country code. This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to “Auto” even if you haven’t defined it in the request.

Please refer to Supported Views for details and to see the available Views.

view?: string

Property Value

string