Map styles

VERSION 0.3.34
PUBLIC PREVIEW

Map style is used to define the look and feel of a map. It’s written in JSON format and specifies how to:

  • Style the symbols, lines, polygons, background, hill shading, heatmap points, raster tiles, circles, and extruded polygons.
  • Specify which of them should be drawn.
  • Set the order in which to draw them.

The structure of the map style can be found in the Map Style Specification documentation.

Different applications may require different styles, so map visualisation can be aligned with brand identity or with specific use cases. For example, the map in a tourist app will show POIs like museums and restaurants, while a truck navigation app will include road shields. The Map Display module comes with two pre-defined styles, but it also supports loading custom styles.

Style variants

Styles can have variants: different versions of the look and feel for different contexts, such as day and night. The Map Display module allows you to assign style variants to different style modes, which are defined by StyleMode. Style mode can be specified by using the MapOptions object. The map can be initialized with either

The mode can also be swapped at runtime. When StyleMode.DARK is set but the style doesn’t have a dark variant, the main style variant is used.

tomTomMap.setStyleMode(StyleMode.DARK)

Dark mode

Loading pre-defined styles

The Map Display module provides pre-defined styles that can be used in the application. They are provided in the StandardStyles object:

  • BROWSING - Style made for browsing the map. This is the default style used by the Map Display module. Browsing style
  • DRIVING - Style to use during navigation. This style renders routes in gray and shows traffic flow and road shields. Driving style

Customizing a style

You can also create your own style to suit your application.

Map styler

The easiest way to do this is to use the Map Styler. It provides a user interface with real-time previews so you can see the effects of your changes.

You can also configure which features are shown in the style using layers. You can find the list of available layers using TomTomMap.layers. Use it to show or hide a layer and to get information about it.

val layers = tomTomMap.layers

Style URIs

Use the StyleDescriptor class to provide the URIs of custom styles. You can create different styles to use for main and dark modes by setting StyleDescriptor.uri and StyleDescriptor.darkUri. The URI for main mode is required.

1val styleDescriptor = StyleDescriptor(
2 uri = URI.create("asset://custom_style.json"),
3 darkUri = URI.create("asset://dark_custom_style.json")
4)

Supported URIs:

  • asset:// - Specifies file located in the asset directory. To retrieve the URI for asset use the URIs object.
    val styleURI = URIs.forAssetFile(assetFile = "custom_style.json")
  • http:// or https:// - Specifies file located on web server.
  • file:// - Specifies file located on file system.

Loading a style

The style can be loaded when the map is initialized by specifying the mapStyle property of the MapOptions object.

1val mapOptions = MapOptions(
2 mapKey = "YOUR_API_KEY",
3 mapStyle = styleDescriptor
4)

You can also change the style of the map at runtime. In that case, OnStyleLoadedCallback is called when style loading has succeeded or failed.

1val styleDescriptor = StyleDescriptor(
2 uri = URI.create("asset://custom_style.json"),
3 darkUri = URI.create("asset://dark_custom_style.json")
4)
5val onStyleLoadedCallback = object : OnStyleLoadedCallback {
6 override fun onSuccess() {
7 /* YOUR CODE GOES HERE */
8 }
9
10 override fun onError(error: LoadingStyleFailure) {
11 /* YOUR CODE GOES HERE */
12 }
13}
14tomTomMap.loadStyle(styleDescriptor, onStyleLoadedCallback)

Custom style