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
specificLanguageProperty()
to specify a desired language for basemap labels. - Set
languageStrategyProperty()
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
-
Property Summary
TypePropertyDescriptionThe option for setting the language for basemap labels.The desired language for place labels on theBasemap
or an empty string if no specific language is required. -
Constructor Summary
ConstructorDescriptionCreates a BasemapStyleParameters that controls how aBasemapStyle
is used when constructing aBasemap
. -
Method Summary
Modifier and TypeMethodDescriptionGets the value of thelanguageStrategy
property.Gets the value of thespecificLanguage
property.The option for setting the language for basemap labels.void
setLanguageStrategy
(BasemapStyleLanguageStrategy languageStrategy) Sets the value of thelanguageStrategy
property.void
setSpecificLanguage
(String specificLanguage) Sets the value of thespecificLanguage
property.The desired language for place labels on theBasemap
or an empty string if no specific language is required.
-
Property Details
-
languageStrategy
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
specificLanguageProperty()
property. Note that theBasemapStyleParameters.specificLanguageProperty()
property takes precedence over theBasemapStyleParameters.languageStrategyProperty()
. If theBasemapStyleParameters.specificLanguageProperty()
is a non-empty string, theBasemapStyleParameters.languageStrategyProperty()
will be ignored.The default value is
BasemapStyleLanguageStrategy.DEFAULT
.Attempting to set the value to null will throw a NullPointerException exception.
- Since:
- 200.3.0
- See Also:
-
specificLanguage
The desired language for place labels on theBasemap
or an empty string if no specific language is required.The
BasemapStyleParameters.specificLanguageProperty()
must be a CLDR (Common Locale Data Repository) format string that uses a two letter language code (e.g. "en" for English) optionally followed by a two letter country code (e.g. "en-US" for US English).If the requested combination of language and country (e.g. "fr-CA") is not supported, the resulting Basemap will fall back to the next most suitable supported language (e.g. "fr").
If no fallback is available, a default language strategy will be used. "global" for ArcGIS basemap styles or "local" for OSM basemap styles.
The list of supported language codes is shown in the table below. To see the latest list of languages supported by the Basemap Styles Service, see the Languages section of the Basemap Styles Service documentation:
Supported language codes Language (CLDR code) Description ar Arabic bs Bosnian bg Bulgarian ca Catalan zh-HK Chinese (Hong Kong) zh-CN Chinese (Simplified) zh-TW Chinese (Taiwan) hr Croatian cs Czech da Danish nl Dutch en English et Estonian fi Finnish fr French de German el Greek he Hebrew hu Hungarian id Indonesian it Italian ja Japanese ko Korean lv Latvian lt Lithuanian nb Norwegian pl Polish pt-BR Portuguese (Brazil) pt-PT Portuguese (Portugal) ro Romanian ru Russian sr Serbian sk Slovak sl Slovenian es Spanish sv Swedish th Thai tr Turkish uk Ukrainian vi Vietnamese If a supported language code is supplied, the labels are displayed in the identified language. If an unsupported language code is used, the label language falls back to the closest available language. For example, American English (en-US) or Canadian French (fr-CA) are not currently supported. These are interpreted as English and French respectively. If no suitable fallback language code is found, labels use the default language for the style.
The default value is an empty string.
If set, this property takes precedence over the
languageStrategyProperty()
.Attempting to set the value to null will throw a NullPointerException exception.
- Since:
- 200.3.0
- See Also:
-
-
Constructor Details
-
BasemapStyleParameters
public BasemapStyleParameters()Creates a BasemapStyleParameters that controls how aBasemapStyle
is used when constructing aBasemap
.After creating a BasemapStyleParameters object,
BasemapStyle
preferences, such as language, can be set.A preference for using global, local, or the system locale language can be set using
languageStrategyProperty()
. To define a preference for a specific language, set thespecificLanguageProperty()
property to a supported language code.- Since:
- 200.3.0
-
-
Method Details
-
languageStrategyProperty
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
specificLanguageProperty()
property. Note that theBasemapStyleParameters.specificLanguageProperty()
property takes precedence over theBasemapStyleParameters.languageStrategyProperty()
. If theBasemapStyleParameters.specificLanguageProperty()
is a non-empty string, theBasemapStyleParameters.languageStrategyProperty()
will be ignored.The default value is
BasemapStyleLanguageStrategy.DEFAULT
.Attempting to set the value to null will throw a NullPointerException exception.
- Returns:
- the
languageStrategy
property - Since:
- 200.3.0
- See Also:
-
getLanguageStrategy
Gets the value of thelanguageStrategy
property.- Property description:
- 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
specificLanguageProperty()
property. Note that theBasemapStyleParameters.specificLanguageProperty()
property takes precedence over theBasemapStyleParameters.languageStrategyProperty()
. If theBasemapStyleParameters.specificLanguageProperty()
is a non-empty string, theBasemapStyleParameters.languageStrategyProperty()
will be ignored.The default value is
BasemapStyleLanguageStrategy.DEFAULT
.Attempting to set the value to null will throw a NullPointerException exception.
- Returns:
- the value of the
languageStrategy
property - Since:
- 200.3.0
- See Also:
-
setLanguageStrategy
Sets the value of thelanguageStrategy
property.- Property description:
- 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
specificLanguageProperty()
property. Note that theBasemapStyleParameters.specificLanguageProperty()
property takes precedence over theBasemapStyleParameters.languageStrategyProperty()
. If theBasemapStyleParameters.specificLanguageProperty()
is a non-empty string, theBasemapStyleParameters.languageStrategyProperty()
will be ignored.The default value is
BasemapStyleLanguageStrategy.DEFAULT
.Attempting to set the value to null will throw a NullPointerException exception.
- Parameters:
languageStrategy
- the value for thelanguageStrategy
property- Since:
- 200.3.0
- See Also:
-
specificLanguageProperty
The desired language for place labels on theBasemap
or an empty string if no specific language is required.The
BasemapStyleParameters.specificLanguageProperty()
must be a CLDR (Common Locale Data Repository) format string that uses a two letter language code (e.g. "en" for English) optionally followed by a two letter country code (e.g. "en-US" for US English).If the requested combination of language and country (e.g. "fr-CA") is not supported, the resulting Basemap will fall back to the next most suitable supported language (e.g. "fr").
If no fallback is available, a default language strategy will be used. "global" for ArcGIS basemap styles or "local" for OSM basemap styles.
The list of supported language codes is shown in the table below. To see the latest list of languages supported by the Basemap Styles Service, see the Languages section of the Basemap Styles Service documentation:
Supported language codes Language (CLDR code) Description ar Arabic bs Bosnian bg Bulgarian ca Catalan zh-HK Chinese (Hong Kong) zh-CN Chinese (Simplified) zh-TW Chinese (Taiwan) hr Croatian cs Czech da Danish nl Dutch en English et Estonian fi Finnish fr French de German el Greek he Hebrew hu Hungarian id Indonesian it Italian ja Japanese ko Korean lv Latvian lt Lithuanian nb Norwegian pl Polish pt-BR Portuguese (Brazil) pt-PT Portuguese (Portugal) ro Romanian ru Russian sr Serbian sk Slovak sl Slovenian es Spanish sv Swedish th Thai tr Turkish uk Ukrainian vi Vietnamese If a supported language code is supplied, the labels are displayed in the identified language. If an unsupported language code is used, the label language falls back to the closest available language. For example, American English (en-US) or Canadian French (fr-CA) are not currently supported. These are interpreted as English and French respectively. If no suitable fallback language code is found, labels use the default language for the style.
The default value is an empty string.
If set, this property takes precedence over the
languageStrategyProperty()
.Attempting to set the value to null will throw a NullPointerException exception.
- Returns:
- the
specificLanguage
property - Since:
- 200.3.0
- See Also:
-
getSpecificLanguage
Gets the value of thespecificLanguage
property.- Property description:
- The desired language for place labels on the
Basemap
or an empty string if no specific language is required.The
BasemapStyleParameters.specificLanguageProperty()
must be a CLDR (Common Locale Data Repository) format string that uses a two letter language code (e.g. "en" for English) optionally followed by a two letter country code (e.g. "en-US" for US English).If the requested combination of language and country (e.g. "fr-CA") is not supported, the resulting Basemap will fall back to the next most suitable supported language (e.g. "fr").
If no fallback is available, a default language strategy will be used. "global" for ArcGIS basemap styles or "local" for OSM basemap styles.
The list of supported language codes is shown in the table below. To see the latest list of languages supported by the Basemap Styles Service, see the Languages section of the Basemap Styles Service documentation:
Supported language codes Language (CLDR code) Description ar Arabic bs Bosnian bg Bulgarian ca Catalan zh-HK Chinese (Hong Kong) zh-CN Chinese (Simplified) zh-TW Chinese (Taiwan) hr Croatian cs Czech da Danish nl Dutch en English et Estonian fi Finnish fr French de German el Greek he Hebrew hu Hungarian id Indonesian it Italian ja Japanese ko Korean lv Latvian lt Lithuanian nb Norwegian pl Polish pt-BR Portuguese (Brazil) pt-PT Portuguese (Portugal) ro Romanian ru Russian sr Serbian sk Slovak sl Slovenian es Spanish sv Swedish th Thai tr Turkish uk Ukrainian vi Vietnamese If a supported language code is supplied, the labels are displayed in the identified language. If an unsupported language code is used, the label language falls back to the closest available language. For example, American English (en-US) or Canadian French (fr-CA) are not currently supported. These are interpreted as English and French respectively. If no suitable fallback language code is found, labels use the default language for the style.
The default value is an empty string.
If set, this property takes precedence over the
languageStrategyProperty()
.Attempting to set the value to null will throw a NullPointerException exception.
- Returns:
- the value of the
specificLanguage
property - Since:
- 200.3.0
- See Also:
-
setSpecificLanguage
Sets the value of thespecificLanguage
property.- Property description:
- The desired language for place labels on the
Basemap
or an empty string if no specific language is required.The
BasemapStyleParameters.specificLanguageProperty()
must be a CLDR (Common Locale Data Repository) format string that uses a two letter language code (e.g. "en" for English) optionally followed by a two letter country code (e.g. "en-US" for US English).If the requested combination of language and country (e.g. "fr-CA") is not supported, the resulting Basemap will fall back to the next most suitable supported language (e.g. "fr").
If no fallback is available, a default language strategy will be used. "global" for ArcGIS basemap styles or "local" for OSM basemap styles.
The list of supported language codes is shown in the table below. To see the latest list of languages supported by the Basemap Styles Service, see the Languages section of the Basemap Styles Service documentation:
Supported language codes Language (CLDR code) Description ar Arabic bs Bosnian bg Bulgarian ca Catalan zh-HK Chinese (Hong Kong) zh-CN Chinese (Simplified) zh-TW Chinese (Taiwan) hr Croatian cs Czech da Danish nl Dutch en English et Estonian fi Finnish fr French de German el Greek he Hebrew hu Hungarian id Indonesian it Italian ja Japanese ko Korean lv Latvian lt Lithuanian nb Norwegian pl Polish pt-BR Portuguese (Brazil) pt-PT Portuguese (Portugal) ro Romanian ru Russian sr Serbian sk Slovak sl Slovenian es Spanish sv Swedish th Thai tr Turkish uk Ukrainian vi Vietnamese If a supported language code is supplied, the labels are displayed in the identified language. If an unsupported language code is used, the label language falls back to the closest available language. For example, American English (en-US) or Canadian French (fr-CA) are not currently supported. These are interpreted as English and French respectively. If no suitable fallback language code is found, labels use the default language for the style.
The default value is an empty string.
If set, this property takes precedence over the
languageStrategyProperty()
.Attempting to set the value to null will throw a NullPointerException exception.
- Parameters:
specificLanguage
- the value for thespecificLanguage
property- Since:
- 200.3.0
- See Also:
-