Constructor Detail

Method Detail

• add

   abstract List<String> add(@NonNull() 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(@NonNull() List<Route> routes, @Nullable() List<RouteRenderOptions> renderOptions)

  Add list of routes on MapView.

  Parameters:

  routes - list of routes to be added to the map

  renderOptions - optional list of options that affect how the routes are rendered

• remove

   abstract void remove(@NonNull() String routeID)

  Remove Route from current MapView

  Parameters:

  routeID - the route's ID used to remove it from the map

• clear

   abstract void clear()

  * Removes all routes from MapView

• updateRouteProgress

   abstract void updateRouteProgress(@NonNull() 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(@NonNull() List<String> routeIDs)

  Get the region that encompasses the given routes

  Parameters:

  routeIDs - list of routes you want to show

• refresh

   abstract String refresh(@NonNull() Route route)

  Refresh Route

  Parameters:

  route - The route.

• refreshAlongRouteTraffic

   abstract String refreshAlongRouteTraffic(@NonNull() AlongRouteTraffic alongRouteTraffic)

  * Refresh alongRouteTraffic

  Parameters:

  alongRouteTraffic - alongRouteTraffic info from drive session callback NavigationEventListener onAlongRouteTrafficUpdated

• refresh

   abstract String refresh(@NonNull() Route route, @Nullable() RouteRenderOptions renderOptions)

  Refresh Route

  Parameters:

  route - The route.

  renderOptions - optional options that affect how the routes are rendered

• highlight

   abstract void highlight(@NonNull() String routeID)

  Highlight Route, only one route is allowed to be highlighted at once.

  Parameters:

  routeID - specify the route to be highlighted.

• unHighlight

   abstract void unHighlight()

  Unhighlight the existing highlighted route.

• getLastEatenRoutePoint

  @Nullable() abstract Location getLastEatenRoutePoint(@NonNull() String routeID)

  Get the last eaten route point

  Parameters:

  routeID - specify the route

• showTurnArrow

   abstract boolean showTurnArrow(String routeName, int selectLegIndex, int selectStepIndex)

  show the specified(through selectLegIndex, selectStepIndex) turn arrow on route

  Parameters:

  routeName - the name of the route to show turn arrow on

  selectLegIndex - the leg index in the route

  selectStepIndex - the step index in the route

• hideTurnArrow

   abstract boolean hideTurnArrow(String routeName, int selectLegIndex, int selectStepIndex)

  hide a specified turn arrow from route

  Parameters:

  routeName - the name of the route to hide turn arrow on

  selectLegIndex - the leg index in the route

  selectStepIndex - the step index in the route

• hideAllTurnArrows

   abstract boolean hideAllTurnArrows()

  hides all currently visible turn arrows

• moveToTurnArrow

   abstract boolean moveToTurnArrow(String routeName, int selectLegIndex, int selectStepIndex)

  moves the camera to a specified turn arrow, call showTurnArrow first

  Parameters:

  routeName - the name of the route to move to turn arrow

  selectLegIndex - the leg index in the route

  selectStepIndex - the step index in the route