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

RouteSettings

interface RouteSettings : RouteExtension, TomtomMapCallback.OnMapTapListener, RouteCallbackExtension, Persistable

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

Inherited Functions

activateProgressAlongRoute

abstract fun activateProgressAlongRoute(routeId: Long, progressStyle: RouteLayerStyle!): Unit

Activate the progress displaying along the route. NOTE: This method itself will not display anything. #updateProgressAlongRoute(long, Location) needs to be called to update the current progress state and display it with the specified style.

addOnRouteClickListener

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

Called to add a listener for route clicks.

addRoute

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

Display a route and prepare the map to navigate on that route.

bringRouteToFront

abstract fun bringRouteToFront(routeId: Long): Unit

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

clearRoute

abstract fun clearRoute(): Unit

Erase route from map.

deactivateProgressAlongRoute

abstract fun deactivateProgressAlongRoute(routeId: Long): Unit

Deactivate the progress displaying along the route.

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.

hideTrafficFromRoute

abstract fun hideTrafficFromRoute(routeId: Long): Unit

Hide traffic on the route.

onMapLongTap

abstract fun onMapLongTap(x: Float!, y: Float!): Unit

TomtomMapCallback.OnMapLongClickListener#onMapLongClick(LatLng)

onMapTap

abstract fun onMapTap(x: Float!, y: Float!): Unit

TomtomMapCallback.OnMapClickListener#onMapClick(LatLng)

onViewStateRestored

abstract fun onViewStateRestored(savedState: MapState!): Unit

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

onViewStateSave

abstract fun onViewStateSave(outState: MapState!): Unit

Called internally to save state, e.g., when the app is going to 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.

removeRoute

abstract fun removeRoute(id: Long): Unit

Removes the route with a given ID from the map.

showTrafficOnRoute

abstract fun showTrafficOnRoute(routeId: Long, trafficStyle: MutableMap<RouteLayerStyle!, MutableList<TrafficData!>!>!): Unit

Draw the traffic on the route.

updateProgressAlongRoute

abstract fun updateProgressAlongRoute(routeId: Long, location: Location!): Unit

Update the state of progress along the specified route. NOTE: #activateProgressAlongRoute(long, RouteLayerStyle) needs to be called first to be able to update the current progress along the specified route.

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.