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

Map Styles Extensions

Map Styles Extensions

The TomTom Maps SDK gives you the ability to use either online or offline styles in your mobile application.

  • If you choose to use offline styles, they will be imported to your app with the Maps SDK package. Thanks to that, the styles will already be included in your app at download time. The styles are added to the Maps SDK package by default.

  • If you choose to use online styles, they will be downloaded into your application when the map is displayed for the first time. Thanks to that, your mobile app size is smaller at the app’s download time so your app downloadable is lighter. In this case you need to exclude offline styles from the SDK.

Offline styles

To use the offline style library, no actions are required because offline styles are attached to the map by default. To use the offline style library with your custom map, add the following dependency to the build.gradle file:

implementation("com.tomtom.online:sdk-maps-styles-extensions:2.4376")

When offline styles are not attached to the project and online styles are not setup for the map, then a black screen will render instead of a map.

 

image

Screen without style

 

Online styles

To exclude offline styles from the sdk-maps module, use an exclude declaration when the sdk-maps module is declared as shown in the following code example.

api("com.tomtom.online:sdk-maps:$rootProject.internalVersions.sdk@aar") {
            transitive = true
            exclude module: 'sdk-maps-styles-extensions'
        }

When offline styles are excluded, then the online styles should be set up. You can set up online styles in MapFragment:

<fragment
    android:id="@+id/map_fragment"
    android:name="com.tomtom.online.sdk.map.MapFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tomtom:customStyleUrl="http://your-server:port/style/example-merged.json" />

You can set up online styles in MapView:

<?xml version="1.0" encoding="utf-8"?>
<com.tomtom.online.sdk.map.MapView xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tomtom="http://schemas.android.com/apk/res-auto"
    android:id="@+id/map_view"
    android:layout_height="match_parent"
    android:layout_width="match_parent"
    tomtom:styleUrl="asset://styles/night.json"
    >
</com.tomtom.online.sdk.map.MapView>

To use the offline style library, no actions are required because the offline styles are attached to the map by default.

To use the offline style library with your custom map, add the following dependency to the build.gradle file:

implementation("com.tomtom.online:sdk-maps-styles-extensions:2.4376")

You are here