Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping

Class BasemapStyleParameters

java.lang.Object
com.esri.arcgisruntime.mapping.BasemapStyleParameters
public final class BasemapStyleParameters extends Object
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.

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 Details

    • languageStrategy

      public ObjectProperty<BasemapStyleLanguageStrategy> 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 the BasemapStyleParameters.specificLanguageProperty() property takes precedence over the BasemapStyleParameters.languageStrategyProperty(). If the BasemapStyleParameters.specificLanguageProperty() is a non-empty string, the BasemapStyleParameters.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

      public StringProperty specificLanguageProperty
      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.

      Since:
      200.3.0
      See Also:

  • Constructor Details

    • BasemapStyleParameters

      public BasemapStyleParameters()
      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.

      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 the specificLanguageProperty() property to a supported language code.

      Since:
      200.3.0

  • Method Details

    • languageStrategyProperty

      public ObjectProperty<BasemapStyleLanguageStrategy> 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 the BasemapStyleParameters.specificLanguageProperty() property takes precedence over the BasemapStyleParameters.languageStrategyProperty(). If the BasemapStyleParameters.specificLanguageProperty() is a non-empty string, the BasemapStyleParameters.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

      public BasemapStyleLanguageStrategy getLanguageStrategy()
      Gets the value of the languageStrategy 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 the BasemapStyleParameters.specificLanguageProperty() property takes precedence over the BasemapStyleParameters.languageStrategyProperty(). If the BasemapStyleParameters.specificLanguageProperty() is a non-empty string, the BasemapStyleParameters.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

      public void setLanguageStrategy(BasemapStyleLanguageStrategy languageStrategy)
      Sets the value of the languageStrategy 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 the BasemapStyleParameters.specificLanguageProperty() property takes precedence over the BasemapStyleParameters.languageStrategyProperty(). If the BasemapStyleParameters.specificLanguageProperty() is a non-empty string, the BasemapStyleParameters.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 the languageStrategy property
      Since:
      200.3.0
      See Also:

    • specificLanguageProperty

      public StringProperty specificLanguageProperty()
      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 specificLanguage property
      Since:
      200.3.0
      See Also:

    • getSpecificLanguage

      public String getSpecificLanguage()
      Gets the value of the specificLanguage 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

      public void setSpecificLanguage(String specificLanguage)
      Sets the value of the specificLanguage 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 the specificLanguage property
      Since:
      200.3.0
      See Also: