Configure basemap style parameters

import InlineCode from "@esri-dx/starship-doc-components/components/InlineCode.astro";

Apply basemap style parameters customization for a basemap, such as displaying all labels in a specific language or displaying every label in their corresponding local language.

Use case

When creating an application that is used in multiple countries, basemaps can reflect the languages and cultures of the users’ location. For example, if an application user is in Greece, displaying the labels on a basemap in Greek reflects the local language. Customizing the language setting on the basemap can be controlled by an application user (such as by setting preferences) or implicitly managed within the application logic (by querying the locale of the platform running the application).

How to use the sample

This sample showcases the workflow of configuring basemap style parameters by displaying a basemap with labels in different languages and launches with a

near Athens, Greece. By default, the is set to , which displays all labels in their corresponding local language. This can be changed to , which displays all labels in English. The option sets all labels to a selected language and overrides the settings.

Pan and zoom to navigate the map to neighboring countries that use different alphabets, such as Bulgaria, and Turkey, to see how different labels are displayed depending on the selected

: all English, all Greek, all Bulgarian, all Turkish, or each their own.

How it works

1. Create a
   object.
2. Configure customization preferences on the
   object, for instance:
   • setting the
     to
     or
   • changes the label language to Greek.
3. Create a basemap using a
   and the
   .
4. Assign the configured basemap to the
   ’s
   property.
5. To modify the basemap style, for example if you want to change your preferences, repeat the above steps.

Relevant API

• Basemap
• BasemapStyleLanguage
• BasemapStyleParameters
• Map
• MapView

About the data

The main data for this sample is the

, which includes basemaps that support both language localization and global language setting. The supported languages, along with their language code, can be found in the API’s documentation.

Additional information

For ArcGIS Basemap styles, language localization becomes visible when you zoom in closer.

Tags

basemap style, language, language strategy, map, point, viewpoint