StyleOptions interface

The options for the map's style.

Extends

Properties

autoResize

If true the map will automatically resize whenever the window's size changes. Otherwise map.resize() must be called. Default true.

language

The language of the map labels. Supported language. Default atlas.getLanguage().

preserveDrawingBuffer

If true, the map's canvas can be exported to a PNG using map.getCanvas().toDataURL(). This option may only be set when initializing the map. Default false

renderWorldCopies

Specfies if multiple copies of the world should be rendered when zoomed out. Default true

showFeedbackLink

Specifies if the feedback link should be displayed on the map or not. Default true

showLogo

Specifies if the Microsoft logo should be hidden or not. If set to true a Microsoft copyright string will be added to the map. Default true

style

The name of the style to use when rendering the map. Available styles can be found in the supported styles article. The default style is "road".

userRegion
view

Specifies which set of geopolitically disputed borders and labels are displayed on the map. The View parameter (also referred to as “user region parameter”) is a 2-letter ISO-3166 Country Code that will show the correct maps for that country/region. Country/Regions that are not on the View list or if unspecified will default to the “Unified” View. Please see the supported Views It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. 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. default: undefined

Property Details

autoResize

If true the map will automatically resize whenever the window's size changes. Otherwise map.resize() must be called. Default true.

autoResize?: boolean

Property Value

boolean

language

The language of the map labels. Supported language. Default atlas.getLanguage().

language?: string

Property Value

string

preserveDrawingBuffer

If true, the map's canvas can be exported to a PNG using map.getCanvas().toDataURL(). This option may only be set when initializing the map. Default false

preserveDrawingBuffer?: boolean

Property Value

boolean

renderWorldCopies

Specfies if multiple copies of the world should be rendered when zoomed out. Default true

renderWorldCopies?: boolean

Property Value

boolean

Specifies if the feedback link should be displayed on the map or not. Default true

showFeedbackLink?: boolean

Property Value

boolean

Specifies if the Microsoft logo should be hidden or not. If set to true a Microsoft copyright string will be added to the map. Default true

showLogo?: boolean

Property Value

boolean

style

The name of the style to use when rendering the map. Available styles can be found in the supported styles article. The default style is "road".

style?: string

Property Value

string

userRegion

Warning

This API is now obsolete.

use view instead.

userRegion?: string

Property Value

string

view

Specifies which set of geopolitically disputed borders and labels are displayed on the map. The View parameter (also referred to as “user region parameter”) is a 2-letter ISO-3166 Country Code that will show the correct maps for that country/region. Country/Regions that are not on the View list or if unspecified will default to the “Unified” View. Please see the supported Views It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. 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. default: undefined

view?: string

Property Value

string