SearchBaseOptions interface

Package:

@azure/maps-search

Base options for search operations

Properties

extendedPostalCodesFor	Indexes for which extended postal codes should be included in the results
language	Language in which search results should be returned.
localizedMapView	The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions.
skip	Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900
top	Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100

Property Details

extendedPostalCodesFor

Indexes for which extended postal codes should be included in the results

extendedPostalCodesFor?: string[]

Property Value

string[]

language

Language in which search results should be returned.

language?: string

Property Value

string

localizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions.

localizedMapView?: string

Property Value

string

skip

Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900

skip?: number

Property Value

number

top

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100

top?: number

Property Value

number