Sorry, you need to enable JavaScript to visit this website.

Custom style

Custom style

You can change the appearance of your map by providing a JSON file containing rendering properties of map elements. Such style file has to:

A basic style is provided as a part of Cumstom Style Resources package.

Styles compliant with Mapbox Style Specification can be edited using style editors like maputnik. Before a style can be edited in maputnik:

  • service key placeholders have to be replaced with actual service keys,

  • sprite and glyph locations have to be replaced by ones that can be reached by maputnik,

  • TomTom-specific tags have to be removed from tile source links or replaced with default values,

  • (optional) visibility of layers can be altered to your preferences.

All these changes, with the exception of layer visibility, have to be reverted before the modified style can be used with the SDK. Custom Style Resources contain a Python script - convertStyle.py - which simplifies this process. Detailed usage instructions can be found in a dedicated section below.

Layer sets

Layers tied to the same data source are treated by the SDK as a layer set. The ID (name) of the data source is used as the name of related layer set. Layer sets listed in Table 1 are required for the SDK to function. If any of these layer sets is absent or does not meet the requirements mentioned below it will be replaced with a default layer set created at runtime.






Table 1. Mandatory layer sets
Map view element Default source name Required layer type Required layer count Source type

Active route polyline

tomtom-active-route

line

2

GeoJSON

Inactive route polyline

tomtom-inactive-route

line

2

GeoJSON

Route start icon

tomtom-start-route

symbol

1

GeoJSON

Route end symbol

tomtom-end-route

symbol

1

GeoJSON

Vehicle icon

tomtom-chevron

symbol

2

GeoJSON

GPS inaccuracy radius

tomtom-gpsradius

circle

2

GeoJSON

Position indicator

tomtom-position

symbol

2

GeoJSON

Two layers for route polyline define the outline and fill styles. Two layers for chevron, GPS radius and position define the styles of two versions of associated objects - normal (active) and dimmed (inactive).

There is a number of layer sets that are important, but not strictly required. They are responsible for providing style and data sources for maps - vector and raster, traffic flow and incidents as well as hybrid overlay. These sets will not be replaced by default ones at runtime.



Table 2. Layer sets important for rendering elements of the map
Map view element Default source name

Vector map

vectorTiles

Raster map

tomtom-raster

Traffic flow

tomtom-flow

Traffic incidents

tomtom-incidents

Hybrid overlay

tomtom-hybrid

User-defined layer set

You can create your own layer sets to replace the default ones. If you use names different than the defaults listed in the tables above, you need to tell the SDK which map view element your custom layer set corresponds to. If names of the layer sets are not delivered, the SDK tries to reach layer sets by using default names.

Source URIs for map layer sets have fixed format - they contain placeholders for API keys and optional parameters. It is not recommended to change them.

Style API

When your custom style is ready, place the JSON file in the /assets/styles/ directory in your Android Studio project or upload it to an online location that your application will be able to access. You can then use your new style in your application.

Even though online style locations are supported, glyphs and sprites have to be stored locally.

Sample use case 1: You want to display a night-themed map with inverted logo colors at night or while in a tunnel.

tomtomMap.getUiSettings().setStyleUrl("asset://styles/night.json");
tomtomMap.getLogoSettings().applyInvertedLogo();

Sample use case 2: You want to switch back to basic style for map and logo.

tomtomMap.getUiSettings().setStyleUrl("asset://styles/mapssdk-default-style.json");
tomtomMap.getLogoSettings().applyDefaultLogo();



image

Basic style

image

Custom night style

Using convertStyle.py

The convertStyle.py script is distributed as a part of the Cumstom Style Resources bundle. It can be executed with one of two commands: 'maputnik' and 'tomtom'. When executed with the 'maputnik' command, it replaces TomTom-specific elements of the base style (-b|--base parameter) with values provided in script’s parameters or in Info.plist or AndroiManifest.xml. when executed with the 'tomtom' command, it reverts changes related to TomTom-specific elements while leaving user’s modification intact.

For the script to work properly, the same base file has to be used for both conversions.
Detailed usage instructions
python2 convertStyle.py <common parameters> <command=maputnik|tomtom> <command-specific parameters>

# All parameters are required unless specified otherwise

common parameters:
  -w WDIR, --wdir WDIR  Working directory. Root of relative paths.
                        [optional, default = "."]
  -S, --silent          Silent mode. No messages will be printed.
  -b BASE, --base BASE  Path to the base for the new style.
  -o OUTPUT, --output OUTPUT
                        Path to the output file.

commands:
    maputnik            Convert a base style so that it can be edited in
                        maputnik.
    tomtom              Convert a style edited in maputnik so that it works
                        with your application using TomTom SDK.

maputnik parameters:
  -k KEYS, --keys KEYS  Path to Info.plist or AndroiManifest.xml.
  -s SPRITES, --sprites SPRITES
                        Online location of sprites.
  -g GLYPHS, --glyphs GLYPHS
                        Online location of glyphs.
  -v {all,none,intact,predefined}, --visibility {all,none,intact,predefined}
                        Change visibility of layers. 'intact' leaves the base
                        style's settings intact, 'predefined' makes vector
                        layers visible and all other layers invisible.
                        [optional, default = "predefined"]

tomtom parameters:
  -e EDITED, --edited EDITED
                        Path to the style edited in maputnik.
Sample workflow
  1. Upload glyphs and sprites to an online location accessible by maputnik.

  2. Use convertStyle.py to create a style that can be edited in maputnik.

    python2 convertStyle.py -b mapssdk-default-style.json -o my_style_prepared_for_maputnik.json maputnik -k path/to/app/AndroiManifest.xml -g http://link.to.glyphs.com -s http://link.to.sprites.com
  3. Upload my_style_prepared_for_maputnik.json to maputnik.

  4. Edit the style in maputnik.

  5. Export the style in maputnik, saving it as my_style_exported_from_maputnik.json.

  6. Use convertStyle.py to prepare the style edited in maputnik to for use with TomTom SDK.

    python2 convertStyle.py -b mapssdk-default-style.json -o my_style_prepared_for_sdk.json tomtom -e my_style_exported_from_maputnik.json