specificLanguage property

String specificLanguage

The desired language for place labels on the Basemap or an empty string if no specific language is required.

The BasemapStyleParameters.specificLanguage 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:

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 BasemapStyleParameters.languageStrategy.

Implementation

String get specificLanguage {
  final stringHandle = _withThrowingErrorHandler((errorHandler) {
    return runtimecore.RT_BasemapStyleParameters_getSpecificLanguage(
      _handle,
      errorHandler,
    );
  });
  return stringHandle.toDartString();
}
void specificLanguage=(String value)

Implementation

set specificLanguage(String value) {
  final coreValue = _CString(value);
  _withThrowingErrorHandler((errorHandler) {
    runtimecore.RT_BasemapStyleParameters_setSpecificLanguage(
      _handle,
      coreValue.bytes,
      errorHandler,
    );
  });
}