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’s 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 Viewpoint
set over Bulgaria, Greece, and Turkey, as they use three different alphabets: Cyrillic, Greek, and Latin, respectively. By default, the BasemapStyleLanguageStrategy
is set to Local
which displays all labels in their corresponding local language. This can be changed to Global
, which displays all labels in English. The SpecificLanguage
setting sets all labels to a selected language and overrides the BasemapStyleLanguageStrategy
settings.
Pan and zoom to navigate the map and see how different labels are displayed in these countries depending on the selected BasemapStyleLanguageStrategy
and SpecificLanguage
: all English, all Greek, all Bulgarian, all Turkish, or each their own.
How it works
- Create a
BasemapStyleParameters
object. - Configure customization preferences on the
BasemapStyleParameters
object, for instance:- setting the
LanguageStrategy
toBasemapStyleLanguageStrategy.Local
or BasemapStyleLanguageStrategy.Specific(Locale.forLanguageTag("el"))
changes the label language to Greek.
- setting the
- The
SpecificLanguage
always overrides theLanguageStrategy
, which means the specific language needs to be set to an empty string in order to use the language strategy. - Create a basemap using a
BasemapStyle
and theBasemapStyleParameters
. - Assign the configured basemap to the
Map
'sbasemap
property. - To modify the basemap style, for example if you want to change your preferences, repeat the above steps.
Relevant API
- Basemap
- BasemapStyleLanguageStrategy
- BasemapStyleParameters
- Map
- MapView
About the data
The main data for this sample is the BasemapStyle
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
This sample uses the GeoView-Compose Toolkit module to be able to implement a composable MapView.
Tags
basemap style, geoview-compose, language, language strategy, map, point, toolkit, viewpoint
Sample Code
/* Copyright 2024 Esri
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.esri.arcgismaps.sample.configurebasemapstyleparameters.components
import android.app.Application
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.setValue
import androidx.lifecycle.AndroidViewModel
import com.arcgismaps.geometry.Point
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.Basemap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.BasemapStyleLanguageStrategy
import com.arcgismaps.mapping.BasemapStyleParameters
import com.arcgismaps.mapping.Viewpoint
import java.util.Locale
class MapViewModel(application: Application) : AndroidViewModel(application) {
val map = ArcGISMap(BasemapStyle.OsmLightGrayBase).apply {
// Focus the viewpoint on an area where the different languages are best showcased:
// Bulgaria / Greece / Turkey, as they use three different alphabets: Cyrillic, Greek, and
// Latin, respectively.
initialViewpoint = Viewpoint(
center = Point(3144804.0, 4904598.0),
scale = 1e7
)
}
// a list of language strategies options
val languageStrategyOptions = listOf("Global", "Local")
// keep track of selected language strategy state
var languageStrategy by mutableStateOf(languageStrategyOptions[1])
private set
// set language strategy and call createNewBasemapStyleParameters
fun updateLanguageStrategy(strategy: String) {
languageStrategy = strategy
createNewBasemapStyleParameters(languageStrategy, specificLanguage)
}
// a list of sample language options
val specificLanguageOptions = listOf("None", "Bulgarian", "Greek", "Turkish")
// keep track of selected specific language state
var specificLanguage by mutableStateOf(specificLanguageOptions[0])
private set
// set specific language and call createNewBasemapStyleParameters
fun updateSpecificStrategy(language: String) {
specificLanguage = language
createNewBasemapStyleParameters(languageStrategy, specificLanguage)
}
init {
// initialize the app with a local basemap style strategy
createNewBasemapStyleParameters(languageStrategy, specificLanguage)
}
/**
* Basemap is immutable so we need to create a new one to set new parameters. Uses an
* OpenStreetMap basemap style, because they support localization.
*/
private fun createNewBasemapStyleParameters(
languageStrategy: String,
specificLanguage: String
) {
val basemapStyleParameters = BasemapStyleParameters().apply {
// A SpecificLanguage setting overrides the BasemapStyleLanguageStrategy settings when
// the BasemapStyleParameters.Specific(Locale.forLanguageTag("...") is a non-empty string.
// Setting the specific language back to an empty string allows the strategy to be used.
this.languageStrategy = when (specificLanguage) {
"None" -> {
BasemapStyleLanguageStrategy.Specific(Locale.forLanguageTag(""))
when (languageStrategy) {
// set the language strategy based on the selected radio buttons
"Global" -> BasemapStyleLanguageStrategy.Global
"Local" -> BasemapStyleLanguageStrategy.Local
else -> throw IllegalArgumentException("Invalid language strategy")
}
}
// set the specific language based on the selected drop down option
"Bulgarian" -> BasemapStyleLanguageStrategy.Specific(Locale.forLanguageTag("bg"))
"Greek" -> BasemapStyleLanguageStrategy.Specific(Locale.forLanguageTag("el"))
"Turkish" -> BasemapStyleLanguageStrategy.Specific(Locale.forLanguageTag("tr"))
else -> throw IllegalArgumentException("Invalid specific language")
}
}
// set a new basemap with the chosen style parameters
map.setBasemap(Basemap(BasemapStyle.OsmLightGray, basemapStyleParameters))
}
}