Skip To Content ArcGIS for Developers Sign In Dashboard

Stop QML Type

A location to stop along a Route. More...

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

Object

Properties

Signals

Methods

Detailed Description

A RouteTask solves a routing problem expressed in a RouteParameters. A RouteParameters includes two or more Stops that the routing solution must visit, including the route's starting location. For example, when routing between your house and your workplace, your house is one stop and your workplace is another.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

Property Documentation

arrivalCurbApproach : Enums.CurbApproach

Returns the arrival curb approach for this Stop (read-only).

See also Enums.CurbApproach.


arrivalTime : date

Returns the arrival time of this Stop in UTC time (read-only).


arrivalTimeShift : double

Returns the value of time zone shift in minutes for the arrival time (read-only).


curbApproach : Enums.CurbApproach

The curb approach for this Stop.

See also Enums.CurbApproach.


currentBearing : double

The current bearing of this Stop.

Both bearing and bearing tolerance have units of degrees.

For bearing, a value of 0 or 360 means north, and 180 means south. Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored.

Bearing and bearing tolerance help to disambiguate how to locate stops. For example, if you are driving on a freeway overpass and you need to reroute, then you would pass in your device compass bearing and a tolerance (say 45 degrees). This information is used to filter out streets that are potentially closer to your device x,y but are heading in the wrong direction (e.g. An underpass street might be closer to the x,y of your device but it is heading in the wrong direction and would be filtered out).

See also currentBearingTolerance.


currentBearingTolerance : double

The current bearing tolerance of this Stop.

Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored. Bearing tolerance units are in degrees. Bearing tolerance is plus or minus the currentBearing provided. For example, you could set the currentBearing to 360, to locate streets to the north, and provide a currentBearingTolerance of 45, to find streets plus or minus 45 degrees from north.

See also currentBearing.


departureCurbApproach : Enums.CurbApproach

Returns the departure curb approach for this Stop (read-only).

See also Enums.CurbApproach.


departureTime : date

Returns the departure time of this Stop in UTC time (read-only).


departureTimeShift : double

Returns the value of time zone shift in minutes for the departure time (read-only).


distanceToNetworkLocation : double

Returns the distance in meters of this Stop along a network path (read-only).

Returns NaN if the Stop has not been located.


[default] geometry : Point

Returns the Point geometry of where this Stop is located (read-only).


locationStatus : Enums.LocationStatus

Returns the LocationStatus of this Stop (read-only).

See also Enums.LocationStatus.


name : string

The name of this Stop.


The navigation latency in seconds.


The navigation speed in meters-per-second.


[default] networkLocation : NetworkLocation

The NetworkLocation of this Stop.


routeName : string

The name of the Route to which the stop belongs.

For example, if you want to find two distinct routes - a route with 4 stops and another with 6 stops - set the name to "Route1" for each of the four stops and "Route2" for each of the 6 stops.


sequence : int

Returns the sequence of this Stop (read-only).


stopId : int

The ID of this Stop.

This QML property was introduced in Esri.ArcGISRuntime 100.6.


stopType : Enums.StopType

The type of a stop.

This QML property was introduced in Esri.ArcGISRuntime 100.1.

See also Enums.StopType.


timeWindowEnd : date

The end of the time window of this Stop in UTC time.

This is the latest time that the Stop can be visited.


timeWindowStart : date

The start of the time window of this Stop in UTC time.

This is the earliest time that the Stop can be visited.


violationTime : double

Returns the violation time of this Stop in minutes (read-only).


waitTime : double

Returns the wait time of this Stop in minutes (read-only).


Signal Documentation

arrivalCurbApproachChanged()

Emitted when the arrivalCurbApproach property of this Stop changes.


arrivalTimeChanged()

Emitted when the arrivalTime property of this Stop changes.


arrivalTimeShiftChanged()

Emitted when the arrivalTimeShift property of this Stop changes.


curbApproachChanged()

Emitted when the curbApproach property of this Stop changes.


currentBearingChanged()

Emitted when the currentBearing property of this Stop changes.


currentBearingToleranceChanged()

Emitted when the currentBearingTolerance property of this Stop changes.


departureCurbApproachChanged()

Emitted when the departureCurbApproach property of this Stop changes.


departureTimeChanged()

Emitted when the departureTime property of this Stop changes.


departureTimeShiftChanged()

Emitted when the departureTimeShift property of this Stop changes.


distanceToNetworkLocationChanged()

Emitted when the distanceToNetworkLocation property of this Stop changes.


geometryChanged()

Emitted when the geometry property of this Stop changes.


locationStatusChanged()

Emitted when the locationStatus property of this Stop changes.


nameChanged()

Emitted when the name property of this Stop changes.


Emitted when the navigationLatency property of this Stop changes.


Emitted when the navigationSpeed property of this Stop changes.


networkLocationChanged()

Emitted when the networkLocation property of this Stop changes.


routeNameChanged()

Emitted when the routeName property of this Stop changes.


sequenceChanged()

Emitted when the sequence property of this Stop changes.


stopIdChanged()

Emitted when the stopId property of this Stop changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


stopTypeChanged()

Emitted when the stopType property of this Stop changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


timeWindowEndChanged()

Emitted when the timeWindowEnd property of this Stop changes.


timeWindowStartChanged()

Emitted when the timeWindowStart property of this Stop changes.


violationTimeChanged()

Emitted when the violationTime property of this Stop changes.


waitTimeChanged()

Emitted when the waitTime property of this Stop changes.


Method Documentation

double addedCost(string attributeName)

Returns added cost of a given attributeName.


double cumulativeCost(string attributeName)

Returns cumulative cost of a given attributeName.


double setAddedCost(string attributeName, double addedCost)

Sets the addedCost for a given attributeName.



Feedback on this topic?