ClosestFacilityRoute QML Type
A ClosestFacilityRoute contains information about the route to maneuver between an incident and a facility. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
Properties
- arrivalCurbApproach : Enums.CurbApproach
- departureCurbApproach : Enums.CurbApproach
- directionManeuvers : DirectionManeuverListModel
- endTime : date
- endTimeShift : double
- routeGeometry : Polyline
- startTime : date
- startTimeShift : double
- totalLength : double
- totalTime : double
- travelTime : double
Methods
- double cost(string attributeName)
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
The ClosestFacilityRoute contains information such as the route geometry, distance, travel time, and direction maneuvers. After ClosestFacilityTask is executed and completes successfully, retrieve the ClosestFacilityRoute from the ClosestFacilityResult.
Property Documentation
arrivalCurbApproach : Enums.CurbApproach |
Returns the departure curb approach populated by the solve (read-only).
The curb approach is dependent on incidents' and facilities' curb approaches.
See also Enums.CurbApproach.
departureCurbApproach : Enums.CurbApproach |
Returns the departure curb approach populated by the solver (read-only).
The curb approach is dependent on incidents' and facilities' curb approaches
See also Enums.CurbApproach.
directionManeuvers : DirectionManeuverListModel |
Returns the directionManeuvers list model for the ClosestFacilityRoute (read-only).
endTime : date |
Returns the end time of a ClosestFacilityRoute in UTC time (read-only).
endTimeShift : double |
Returns the value of time zone shift for end time in minutes (read-only).
routeGeometry : Polyline |
Returns the geometry of the route to the closest facility (read-only).
startTime : date |
Returns the start time of a ClosestFacilityRoute in UTC time (read-only).
startTimeShift : double |
Returns the value of time zone shift for start time in minutes (read-only).
totalLength : double |
Returns the total length (distance) of the ClosestFacilityRoute (read-only).
The returned value's units is in meters.
totalTime : double |
Returns the total time of a ClosestFacilityRoute in minutes (read-only).
This includes the travel time, as well as any additional time from specified incident or facility costs.
travelTime : double |
Returns the travel time of a ClosestFacilityRoute in minutes (read-only).
This only includes time of travel.
Method Documentation
double cost(string attributeName) |
Returns the cost of a given attributeName.
Example attribute names include "Minutes" or "TravelTime".