A Route contains information about the best way to maneuver between a series of Stops. More...
Import Statement: | import Esri.ArcGISRuntime 100.15 |
Since: | Esri.ArcGISRuntime 100.0 |
Inherits: |
Properties
- directionManeuvers : DirectionManeuverListModel
- endTime : date
- endTimeShift : double
- routeGeometry : Polyline
- routeName : string
- startTime : date
- startTimeShift : double
- stops : list<Stop>
- totalLength : double
- totalTime : double
- travelTime : double
- violationTime : double
- waitTime : double
Methods
- double cost(string attributeName)
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
A Route is obtained from a RouteResult once a RouteTask is solved. The Route contains information such as the route geometry, distance, travel time, and direction maneuvers. Obtain a Route from the RouteResult, once a RouteTask is executed and completes successfully.
Property Documentation
directionManeuvers : DirectionManeuverListModel |
Returns a DirectionManeuvers list model for the Route (read-only).
routeGeometry : Polyline |
Returns the Route geometry that connects the various Stops (read-only).
stops : list<Stop> |
Returns a list of Stops used in this Route (read-only).
Only applicable if RouteParameters::returnStops used in the associated RouteTask is true
.
Returns the total length (distance) of the Route (read-only).
The returned value's units is in meters.
Returns the total time of a Route in minutes (read-only).
This includes any travel time, time spent waiting at stops (arriving before the start of a time window), and service time at stops.
Returns the travel time of a Route in minutes (read-only).
This only includes time of travel.
Returns the violation time of a Route in minutes (read-only).
This includes the total amount of additional time incurred due to time window violations.
Returns the wait time of a Route in minutes (read-only).
This includes the total amount of additional time incurred due to waiting at time windows.
Method Documentation
Returns the cost of a given attributeName.
Example attribute names include "Minutes" or "TravelTime".