Interface nokia.maps.routing.Route
Interface Summary
This interface defines a route. A route describes a path through the route network between at least two waypoints (start and end). It is calculated by a back-end server and includes a list of route links and maneuvers. A maneuver describes an action a person needs to perform to follow a route. For example, it can contain an instruction to turn right or left or an indication of the direction of travel, etc. A maneuver applies to a route link, which is a part of a route that has a unique id (allocated by the server) and consists of a list of points/locations (defined in terms of their geographic coordinates).
Field Summary
nokia.maps.routing.RouteLeg[]
legs
This property holds an array that represents the partition of the route into legs between the different waypoints.
nokia.maps.routing.Mode
mode
This property holds an object that represents the route mode used in the route calculation.
String
routeId
This property holds a unique identifier of the route.
nokia.maps.geo.Shape
shape
This property holds a route shape object as a polyline.
nokia.maps.routing.Waypoint[]
waypoints
This property holds a list of waypoints that have been defined when requesting a route calculation.
Field Detail
nokia.maps.routing.RouteLeg[]
legs
This property holds an array that represents the partition of the route into
legs between the different waypoints.
String
routeId
This property holds a unique identifier of the route. The value is calculated from the route
links and can be used to reproduce any previously calculated route. Thus,
routeId
is not a temporary ID, but can be used as a persistent reference to the route.
nokia.maps.geo.Shape
shape
This property holds a route shape object as a polyline.
Its accuracy depends on the resolution specified in mpp (meters per pixel) when
requesting the route. In some use cases (such as Web portals), only the route's
shape is required, without the nested structure and detailed knowledge
of the links and their ids; the shape does not need to be acquired by
traversing the route's links, but can be represented using this attribute at route
level.
nokia.maps.routing.Waypoint[]
waypoints
This property holds a list of waypoints that have been defined when requesting
a route calculation. The first waypoint is defined as the start of the route;
the last waypoint marks the destination. Any waypoints in between the two define
"via points".