RenderGetMapTileOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
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. |
tile |
The size of the returned map tile in pixels. |
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
abort |
The signal which can be used to abort requests. |
custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
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 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
tileSize
The size of the returned map tile in pixels.
tileSize?: 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
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