Edit

MobilityGetMetroAreaPreviewOptionalParams interface

  • Reference
Package:
azure-maps-rest

Optional Parameters.

Extends

RequestOptionsBase

Properties

language

Language in which search results will be returned. Only NGT is supported. Please refer to Supported languages for details.
queryType

The type of the query. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g. "47.641268,-122.125679”. Possible values include: 'position', 'countryCode'

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

language

Language in which search results will be returned. Only NGT is supported. Please refer to Supported languages for details.

language?: string

Property Value

string

queryType

The type of the query. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g. "47.641268,-122.125679”. Possible values include: 'position', 'countryCode'

queryType?: MetroAreaQueryType

Property Value

MetroAreaQueryType

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