SearchGetSearchAddressReverseOptionalParams interface

Optional Parameters.

Extends
RequestOptionsBase

Properties

abortSignal

The signal which can be used to abort requests.

allowFreeformNewline

Format of newlines in the formatted address. If true, the address will contain newlines. If false, newlines will be converted to commas.

customHeaders

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

entityType

Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via Get Search Polygon API. Possible values include: 'Country', 'CountrySubdivision', 'CountrySecondarySubdivision', 'CountryTertiarySubdivision', 'Municipality', 'MunicipalitySubdivision', 'Neighbourhood', 'PostalCodeArea'

heading

The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place

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.

number

If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number

onDownloadProgress

Callback which fires upon download progress.

onUploadProgress

Callback which fires upon upload progress.

radius

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

returnMatchType

Include information on the type of match the geocoder achieved in the response.

returnRoadUse

Boolean. To enable return of the road use array for reversegeocodes at street level

returnSpeedLimit

Boolean. To enable return of the posted speedlimit

roadUse

To restrict reversegeocodes to a certain type of roaduse. The road use array for reversegeocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

timeout

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

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.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

allowFreeformNewline

Format of newlines in the formatted address. If true, the address will contain newlines. If false, newlines will be converted to commas.

allowFreeformNewline?: boolean

Property Value

boolean

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

entityType

Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via Get Search Polygon API. Possible values include: 'Country', 'CountrySubdivision', 'CountrySecondarySubdivision', 'CountryTertiarySubdivision', 'Municipality', 'MunicipalitySubdivision', 'Neighbourhood', 'PostalCodeArea'

entityType?: EntityType

Property Value

heading

The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place

heading?: number

Property Value

number

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

number

If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number

number?: string

Property Value

string

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

radius

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

radius?: number

Property Value

number

returnMatchType

Include information on the type of match the geocoder achieved in the response.

returnMatchType?: boolean

Property Value

boolean

returnRoadUse

Boolean. To enable return of the road use array for reversegeocodes at street level

returnRoadUse?: boolean

Property Value

boolean

returnSpeedLimit

Boolean. To enable return of the posted speedlimit

returnSpeedLimit?: boolean

Property Value

boolean

roadUse

To restrict reversegeocodes to a certain type of roaduse. The road use array for reversegeocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

roadUse?: string

Property Value

string

timeout

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

timeout?: number

Property Value

number

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