-
- All Implemented Interfaces:
public interface RoutesController
-
-
Method Summary
Modifier and Type Method Description abstract List<String>add(List<Route> routes)Add list of routes on MapView. abstract List<String>add(List<Route> routes, List<RouteRenderOptions> renderOptions)Add list of routes on MapView. abstract Unitremove(String routeID)Remove Route from current MapView abstract Unitclear()abstract UnitupdateRouteProgress(String routeID)abstract Camera.Regionregion(List<String> routeIDs)Get the region that encompasses the given routes abstract Stringrefresh(Route route)Refresh Route abstract Stringrefresh(Route route, RouteRenderOptions renderOptions)Refresh Route abstract StringrefreshAlongRouteTraffic(AlongRouteTraffic alongRouteTraffic)abstract Unithighlight(String routeID)Highlight Route, only one route is allowed to be highlighted at once. abstract UnitunHighlight()Unhighlight the existing highlighted route. abstract LocationgetLastEatenRoutePoint(String routeID)Get the last eaten route point abstract BooleanshowTurnArrow(String routeName, Integer selectLegIndex, Integer selectStepIndex)show the specified(through selectLegIndex, selectStepIndex) turn arrow on route abstract BooleanhideTurnArrow(String routeName, Integer selectLegIndex, Integer selectStepIndex)hide a specified turn arrow from route abstract BooleanhideAllTurnArrows()hides all currently visible turn arrows abstract BooleanmoveToTurnArrow(String routeName, Integer selectLegIndex, Integer selectStepIndex)moves the camera to a specified turn arrow, call showTurnArrow first -
-
Method Detail
-
add
abstract List<String> add(List<Route> routes)
Add list of routes on MapView.
- Parameters:
routes- list of routes to be added to the map
-
add
abstract List<String> add(List<Route> routes, List<RouteRenderOptions> renderOptions)
Add list of routes on MapView.
- Parameters:
routes- list of routes to be added to the maprenderOptions- optional list of options that affect how the routes are rendered
-
remove
abstract Unit remove(String routeID)
Remove Route from current MapView
- Parameters:
routeID- the route's ID used to remove it from the map
-
updateRouteProgress
abstract Unit updateRouteProgress(String routeID)
Call this function to hide sections of the route that the vehicle has already passed. The function only needs to be called once.
- Parameters:
routeID- the route to be updated.
-
region
abstract Camera.Region region(List<String> routeIDs)
Get the region that encompasses the given routes
- Parameters:
routeIDs- list of routes you want to show
-
refresh
abstract String refresh(Route route, RouteRenderOptions renderOptions)
Refresh Route
- Parameters:
route- The route.renderOptions- optional options that affect how the routes are rendered
-
refreshAlongRouteTraffic
abstract String refreshAlongRouteTraffic(AlongRouteTraffic alongRouteTraffic)
Refresh alongRouteTraffic
- Parameters:
alongRouteTraffic- alongRouteTraffic info from drive session callback NavigationEventListener onAlongRouteTrafficUpdated
-
highlight
abstract Unit highlight(String routeID)
Highlight Route, only one route is allowed to be highlighted at once.
- Parameters:
routeID- specify the route to be highlighted.
-
unHighlight
abstract Unit unHighlight()
Unhighlight the existing highlighted route.
-
getLastEatenRoutePoint
abstract Location getLastEatenRoutePoint(String routeID)
Get the last eaten route point
- Parameters:
routeID- specify the route
-
showTurnArrow
abstract Boolean showTurnArrow(String routeName, Integer selectLegIndex, Integer selectStepIndex)
show the specified(through selectLegIndex, selectStepIndex) turn arrow on route
- Parameters:
routeName- the name of the route to show turn arrow onselectLegIndex- the leg index in the routeselectStepIndex- the step index in the route
-
hideTurnArrow
abstract Boolean hideTurnArrow(String routeName, Integer selectLegIndex, Integer selectStepIndex)
hide a specified turn arrow from route
- Parameters:
routeName- the name of the route to hide turn arrow onselectLegIndex- the leg index in the routeselectStepIndex- the step index in the route
-
hideAllTurnArrows
abstract Boolean hideAllTurnArrows()
hides all currently visible turn arrows
-
moveToTurnArrow
abstract Boolean moveToTurnArrow(String routeName, Integer selectLegIndex, Integer selectStepIndex)
moves the camera to a specified turn arrow, call showTurnArrow first
- Parameters:
routeName- the name of the route to move to turn arrowselectLegIndex- the leg index in the routeselectStepIndex- the step index in the route
-
-
-
-