-
- All Implemented Interfaces:
public final class RouteRenderOptionsOptions that define how the route will be styled for rendering
-
-
Field Summary
Fields Modifier and Type Field Description private BooleanstyleWithTrafficprivate RouteEdgeIndexunreachableEdgeIndexprivate BooleanalternativeRouteprivate RouteEdgeIndexfirstAlternativeRouteEdge
-
Constructor Summary
Constructors Constructor Description RouteRenderOptions(Boolean styleWithTraffic, RouteEdgeIndex unreachableEdgeIndex, Boolean alternativeRoute, RouteEdgeIndex firstAlternativeRouteEdge)
-
Method Summary
Modifier and Type Method Description final BooleangetStyleWithTraffic()Denote whether or not to use traffic information to style the route accordingly. final UnitsetStyleWithTraffic(Boolean styleWithTraffic)Denote whether or not to use traffic information to style the route accordingly. final RouteEdgeIndexgetUnreachableEdgeIndex()Mark the index that describes the point on the route which the destination will be unreachable NOTE: Out of range meaning the vehicle is out of fuel/electricity final UnitsetUnreachableEdgeIndex(RouteEdgeIndex unreachableEdgeIndex)Mark the index that describes the point on the route which the destination will be unreachable NOTE: Out of range meaning the vehicle is out of fuel/electricity final BooleangetAlternativeRoute()Indicates whether the route is an alternative route. final UnitsetAlternativeRoute(Boolean alternativeRoute)Indicates whether the route is an alternative route. final RouteEdgeIndexgetFirstAlternativeRouteEdge()Indicates the first edge index of the alternative route. final UnitsetFirstAlternativeRouteEdge(RouteEdgeIndex firstAlternativeRouteEdge)Indicates the first edge index of the alternative route. -
-
Constructor Detail
-
RouteRenderOptions
RouteRenderOptions(Boolean styleWithTraffic, RouteEdgeIndex unreachableEdgeIndex, Boolean alternativeRoute, RouteEdgeIndex firstAlternativeRouteEdge)
-
-
Method Detail
-
getStyleWithTraffic
final Boolean getStyleWithTraffic()
Denote whether or not to use traffic information to style the route accordingly. NOTE: Default is true
-
setStyleWithTraffic
final Unit setStyleWithTraffic(Boolean styleWithTraffic)
Denote whether or not to use traffic information to style the route accordingly. NOTE: Default is true
-
getUnreachableEdgeIndex
final RouteEdgeIndex getUnreachableEdgeIndex()
Mark the index that describes the point on the route which the destination will be unreachable NOTE: Out of range meaning the vehicle is out of fuel/electricity
-
setUnreachableEdgeIndex
final Unit setUnreachableEdgeIndex(RouteEdgeIndex unreachableEdgeIndex)
Mark the index that describes the point on the route which the destination will be unreachable NOTE: Out of range meaning the vehicle is out of fuel/electricity
-
getAlternativeRoute
final Boolean getAlternativeRoute()
Indicates whether the route is an alternative route. This is used to differentiate between the main route and alternative routes.
-
setAlternativeRoute
final Unit setAlternativeRoute(Boolean alternativeRoute)
Indicates whether the route is an alternative route. This is used to differentiate between the main route and alternative routes.
-
getFirstAlternativeRouteEdge
final RouteEdgeIndex getFirstAlternativeRouteEdge()
Indicates the first edge index of the alternative route. If set this value, the edge before first edge will be drawn as trace style
-
setFirstAlternativeRouteEdge
final Unit setFirstAlternativeRouteEdge(RouteEdgeIndex firstAlternativeRouteEdge)
Indicates the first edge index of the alternative route. If set this value, the edge before first edge will be drawn as trace style
-
-
-
-