com.tomtom.online.sdk.map

Interface RouteSettings

All Superinterfaces:

com.tomtom.core.maps.OnMapTapListener, Persistable

public interface RouteSettings
extends com.tomtom.core.maps.OnMapTapListener, Persistable

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

Method Summary

Modifier and Type	Method and Description
void	addOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener) Called to add a listener for route clicks.
Route	addRoute(RouteBuilder routeBuilder) Display route and prepare map to navigate on that route.
void	bringRouteToFront(long routeId) Bring the specific route to front.
void	clearRoute() Erase route from map.
void	displayRouteOverview(long id) Display route overview using its id.
void	displayRoutesOverview() Display route overview.
Optional<Route>	findRouteByID(long id) Find route using its id.
java.util.List<Route>	getRoutes() Get list of all routs added to the map.
void	removeOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener) Called to remove a listener for route clicks.
void	removeOnRouteClickListeners() Remove all registered route click listeners.
void	setRouteActive(long routeId) Deprecated.
void	setRouteInactive(long routeId) Deprecated.
void	setRoutesActive() Deprecated.
void	setRoutesInactive() Deprecated.
void	updateRouteStyle(long routeId, RouteStyle routeStyle) Updates the style of the specific route in terms of route's properties like: width, fillColor and outlineColor.

Methods inherited from interface com.tomtom.core.maps.OnMapTapListener

onMapLongTap, onMapTap

Methods inherited from interface com.tomtom.online.sdk.map.Persistable

onViewStateRestored

Method Detail

addRoute

Route addRoute(RouteBuilder routeBuilder)

Display route and prepare map to navigate on that route.

getRoutes

java.util.List<Route> getRoutes()

Get list of all routs added to the map.

clearRoute

void clearRoute()

Erase route from map.

displayRoutesOverview

void displayRoutesOverview()

Display route overview. All added routes will be visible.

displayRouteOverview

void displayRouteOverview(long id)

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

findRouteByID

Optional<Route> findRouteByID(long id)

Find route using its id.

updateRouteStyle

void updateRouteStyle(long routeId,
                      RouteStyle routeStyle)

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

Parameters:

routeId - the id of the map's route.

routeStyle - the new style for the map's route.

bringRouteToFront

void bringRouteToFront(long routeId)

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

Parameters:

routeId - the id of the map's route.

setRoutesInactive

@Deprecated
 @DeprecatedSince(month=10,
                 year=2018)
void setRoutesInactive()

Deprecated.

Mark all added routes as inactive. Inactive routes are drawn using gray color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method.

setRoutesActive

@Deprecated
 @DeprecatedSince(month=10,
                 year=2018)
void setRoutesActive()

Deprecated.

Mark all added routes as active. Active routes are drawn using blue color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method.

setRouteActive

@Deprecated
 @DeprecatedSince(month=10,
                 year=2018)
void setRouteActive(long routeId)

Deprecated.

Mark route with a given id as active. Active route is drawn using blue color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method. No action if route does not exist.

setRouteInactive

@Deprecated
 @DeprecatedSince(month=10,
                 year=2018)
void setRouteInactive(long routeId)

Deprecated.

Mark route with a given id as inactive. Inactive route is drawn using gray color. Use RouteExtension.updateRouteStyle(long, RouteStyle) to change route color instead of using this method. No action if route does not exist.

addOnRouteClickListener

void addOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)

Called to add a listener for route clicks.

Parameters:

listener - Listener to be added for route clicks.

removeOnRouteClickListener

void removeOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)

Called to remove a listener for route clicks.

Parameters:

listener - Listener to be removed for route clicks.

removeOnRouteClickListeners

void removeOnRouteClickListeners()

Remove all registered route click listeners.