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

RouteExtension

interface RouteExtension

Interface for route manipulation with the map.

Functions

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.

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.