Route QML Type

A Route contains information about the best way to maneuver between a series of Stops. More...

Import Statement: import Esri.ArcGISRuntime 100.14
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

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).


endTime : date

Returns the end time of a Route 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 Route geometry that connects the various Stops (read-only).


routeName : string

Returns the name of the Route (read-only).


startTime : date

Returns the start time of a Route in UTC time (read-only).


startTimeShift : double

Returns the value of time zone shift for start time in minutes (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.


totalLength : double

Returns the total length (distance) of the Route (read-only).

The returned value's units is in meters.


totalTime : double

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.


travelTime : double

Returns the travel time of a Route in minutes (read-only).

This only includes time of travel.


violationTime : double

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.


waitTime : double

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

double cost(string attributeName)

Returns the cost of a given attributeName.

Example attribute names include "Minutes" or "TravelTime".


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.