SearchGetSearchAddressOptionalParams interface

Package:

azure-maps-rest

Optional Parameters.

Extends

RequestOptionsBase

Properties

btmRight	Bottom right position of the bounding box. E.g. 37.553,-122.453
countrySet	Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries
extendedPostalCodesFor	Indexes for which extended postal codes should be included in the results. Available indexes are: Addr = Address ranges Geo = Geographies PAD = Point Addresses POI = Points of Interest Str = Streets XStr = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or None for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.
language	Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.
lat	Latitude where results should be biased. E.g. 37.337
limit	Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100
lon	Longitude where results should be biased. E.g. -121.89
ofs	Starting offset of the returned results within the full result set.
radius	The radius in meters to for the results to be constrained to the defined area
topLeft	Top left position of the bounding box. E.g. 37.553,-122.453
typeahead	Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode
view	The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to Supported Views for details and to see the available Views.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

btmRight

Bottom right position of the bounding box. E.g. 37.553,-122.453

btmRight?: string

Property Value

string

countrySet

Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries

countrySet?: string[]

Property Value

string[]

extendedPostalCodesFor

Indexes for which extended postal codes should be included in the results. Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

extendedPostalCodesFor?: string

Property Value

string

language

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.

language?: string

Property Value

string

lat

Latitude where results should be biased. E.g. 37.337

lat?: number

Property Value

number

limit

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

limit?: number

Property Value

number

lon

Longitude where results should be biased. E.g. -121.89

lon?: number

Property Value

number

ofs

Starting offset of the returned results within the full result set.

ofs?: number

Property Value

number

radius

The radius in meters to for the results to be constrained to the defined area

radius?: number

Property Value

number

topLeft

Top left position of the bounding box. E.g. 37.553,-122.453

topLeft?: string

Property Value

string

typeahead

Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode

typeahead?: boolean

Property Value

boolean

view

The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to Supported Views for details and to see the available Views.

view?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

Inherited From RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From RequestOptionsBase.timeout