User location

VERSION 2.5.3

The Map Display Compose module allows you to show the current user location on the map. Location data is provided by the LocationProvider and is used to display the user location marker indicator on the map.

Using the location provider with the map

Location updates are generated by the LocationProvider. To receive them, you need to configure MapDisplayInfrastructure using an instance of LocationProvider. It will be used by the map to position the location marker according to the position updates.

1
val mapDisplayInfrastructure = MapDisplayInfrastructure(TomTomSdk.sdkContext) {
2
    locationInfrastructure = MapLocationInfrastructure {
3
        locationProvider = myLocationProvider
4
    }
5
}

You can also use the LocationState from the MapViewState instance to retrieve the current user location or check whether the location marker is visible on the screen.

Note that if the LocationProvider was not set, or if it did not provide any location data, the current location will not be available.

1
val isLocationInVisibleArea = mapViewState.locationState.isCurrentLocationInMapBoundingBox()
2
val currentLocation: GeoLocation? = mapViewState.locationState.getCurrentLocation()

Location marker

The user location is shown as a CurrentLocationMarker on the map.

1
TomTomMap(
2
    infrastructure = mapDisplayInfrastructure,
3
    state = mapViewState,
4
) {
5
    CurrentLocationMarker(
6
        properties = CurrentLocationMarkerProperties {
7
            type = Type.Chevron
8
        },
9
    )
10
}

The location marker is displayed as shown below.

Chevron

Next steps

Since you have learned how to show user locations, here are recommendations for the next steps: