sdk-maps / com.tomtom.online.sdk.map / RouteSettings

RouteSettings

interface RouteSettings : RouteExtension, OnMapTapListener, RouteCallbackExtension, Persistable

Advanced settings for routes manipulation. To obtain this interface, call TomtomMap#getRouteSettings()

Inherited Functions

addOnRouteClickListener

abstract fun addOnRouteClickListener(listener: TomtomMapCallback.OnRouteClickListener!): Unit

Called to add a listener for route clicks.

addRoute

abstract fun addRoute(routeBuilder: RouteBuilder!): Route!

Display route and prepare map to navigate on that route.

bringRouteToFront

abstract fun bringRouteToFront(routeId: Long): Unit

Bring the specific route to front. As a result, it will be drawn on top of other routes.

clearRoute

abstract fun clearRoute(): Unit

Erase route from map.

displayRouteOverview

abstract fun displayRouteOverview(id: Long): Unit

Display route overview using its id. No action when route not found.

displayRoutesOverview

abstract fun displayRoutesOverview(): Unit

Display route overview. All added routes will be visible.

findRouteByID

abstract fun findRouteByID(id: Long): Optional<Route!>!

Find route using its id.

getRoutes

abstract fun getRoutes(): MutableList<Route!>!

Get list of all routs added to the map.

onViewStateRestored

abstract fun onViewStateRestored(savedState: MapState!): Unit

Called internally to restore state, e.g. when app is resumed from the background.

removeOnRouteClickListener

abstract fun removeOnRouteClickListener(listener: TomtomMapCallback.OnRouteClickListener!): Unit

Called to remove a listener for route clicks.

removeOnRouteClickListeners

abstract fun removeOnRouteClickListeners(): Unit

Remove all registered route click listeners.

updateRouteStyle

abstract fun updateRouteStyle(routeId: Long, routeStyle: RouteStyle!): Unit

Updates the style of the specific route in terms of route's properties like: width, fillColor and outlineColor.