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

RouteExtension

interface RouteExtension

Interface for route manipulation with the map.

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.
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.
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.

Inheritors

RouteSettings

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

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

TomtomMap

interface TomtomMap : RouteExtension, MarkerExtension, MapManipulationExtension, MapInfoExtension, MapCallbacksExtension, MapViewExtension, MarkersCallbackExtension, OverlaysCallbackExtension, RouteCallbackExtension, LocationSourceExtension, OnRequestPermissionsResultCallback, CameraCallbacksExtension

Interface that is the main entry point for all methods related to the map. TomtomMap is obtained using the MapFragment#getAsyncMap(OnMapReadyCallback) method on a MapFragment.