Interface nokia.maps.routing.Mode
Interface Summary
This interface defines route modes, types and other options applicable to route calculations.
Field Summary
String[]
options
Optional
This property specifies the routing options to be applied when calculating the route.
String
trafficMode
Optional
This property indicates if traffic information is to be considered when calculating the route.
String[]
transportModes
This property defines the transport mode to be used in the route calculation.
String
type
This property holds a route type applicable to the route calculation.
Field Detail
String[]
options
Optional
This property specifies the routing options to be applied when calculating the route.
The possible values are:
"avoidTollroad"- indicates that the route should avoid toll roads"avoidMotorway"- indicates that the route should avoid motorways (highways)"avoidBoatFerry"- indicates that the route should avoid boat ferries"avoidRailFerry"- indicates that the route should avoid rail ferries"avoidPublicTransport"- indicates that the route should avoid public transport"avoidTunnel"- indicates that the route should avoid tunnels"avoidDirtRoad"- indicates that the route should avoid dirt roads"avoidPark"- indicates that the route should avoid parks"preferHOVLane"- indicates that the route should give preference to high-occupancy vehicle (HOV) lanes"avoidStairs"- indicates that the route should avoid stairs
String
trafficMode
Optional
This property indicates if traffic information is to be considered when calculating the route.
The possible values are:
"enabled"- indicates that the dynamic traffic conditions are to be taken into account (current traffic traffic patterns, short term closures, long term closures"disabled"- indicates that dynamic traffic conditions are not to be taken into account, but only time restrictions and seasonal closures"default"- indicates that the service is to apply traffic-related constraints suitable for the selected routing type, transport mode and departure time, and it is to take into consideration user entitlements automatically
String[]
transportModes
This property defines the transport mode to be used in the route calculation.
The possible values are:
"car"- indicates that the route is to be suitable for cars"pedestrian"- indicates that the route is for pedestrians (walking)"publicTransport"- indicates that the route is to be traveled using public transport"truck"- indicates that the route is to be suitable for trucks (heavy goods vehicles)
String
type
This property holds a route type applicable to the route calculation.
The possible values are:
"shortest"- the shortest route between the start and finish points, disregarding traffic conditions"fastest"- a route that allows the destination to be reached in the shortest amount of time; the travel time takes into consideration traffic information (iftrafficModeis selected)"fastestNow"- a convenience option that combines the route type "fastest" with the traffic mode "enabled" and takes into consideration the departure time; if the departure time is omitted, the current time ("now") is assumed"directDrive"- an option that combines the route type "fastest" and the traffic mode "disabled" and takes into consideration the departure time; if departure time is omitted, the current time ("now") is assumed"scenic"- a route that favors interesting scenery and landscapes
