BasemapStyleParameters

Provides parameters for creating a Basemap from a BasemapStyle. BasemapStyleParameters allows you to set preferences, such as the language to use for basemap labels, when creating a Basemap that suits your application.

BasemapStyleParameters build upon a BasemapStyle to adjust settings for how that style is displayed. For example, you can choose from a set of options that determine the language for displaying labels on the basemap.

  • Set the BasemapStyleParameters.specificLanguage to specify a desired language for basemap labels.

  • Set BasemapStyleParameters.languageStrategy to use local language, use global language, or attempt to use the application locale.

Once you are finished configuring the options for your BasemapStyleParameters, they can be used with a BasemapStyle to create a Basemap. When the Basemap is loaded, the parameters in the BasemapStyleParameters are evaluated.

Since

200.3.0

Constructors

Link copied to clipboard
constructor()

Creates a BasemapStyleParameters that controls how a BasemapStyle is used when constructing a Basemap. After creating a BasemapStyleParameters object, BasemapStyle preferences, such as language, can be set.

Properties

Link copied to clipboard

The option for setting the language for basemap labels. This property allows you to specify an option for the language to use for basemap labels. You can use global or local place names or attempt to use the system locale. If you want to use a specific language, set the BasemapStyleParameters.specificLanguage property. Note that the BasemapStyleParameters.specificLanguage property takes precedence over the BasemapStyleParameters.languageStrategy. If the BasemapStyleParameters.specificLanguage is a non-empty string, the BasemapStyleParameters.languageStrategy will be ignored.

Link copied to clipboard

Specifies the desired representation of a boundary between countries on a Basemap where the location of the boundary is disputed. This parameter defines the boundary lines and labels displayed on a Basemap. If no value is defined, the style will use the standard set of boundary lines and labels defined by the style. Note that there may be cases where labels for a given disputed area are not available in all languages. In that case, the language for the label may change by falling back to the default.