RouteTaskInfo QML Type

Information about a RouteTask. More...

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



Detailed Description

Note: You cannot declare or create a component of this type in QML code.

RouteTaskInfo contains the network dataset defaults from the RouteTask once it is loaded. Use this type to obtain information about RouteTask defaults before setting RouteParameters.

Property Documentation

accumulateAttributeNames : list<string>

Returns names of all the accumulated attributes (read-only).

costAttributes : jsobject

Returns the cost attributes as a key-value pair (read-only).

The key is the name as a string, and the value is the CostAttribute.

defaultTravelModeName : string

Returns the name of the default travel mode (read-only).

If the route task is initialized with a URL or local network that has no travel modes, then the default travel mode name is an empty string.

directionsDistanceUnits : Enums.UnitSystem

Returns the units in which the length information will be reported in the route directions (read-only).

See also Enums.UnitSystem.

directionsLanguage : string

Returns the language of the resulting route directions (read-only).

directionsStyle : Enums.DirectionsStyle

Returns the style of the resulting route directions (read-only).

See also Enums.DirectionsStyle.

[since Esri.ArcGISRuntime 100.7] directionsSupport : Enums.NetworkDirectionsSupport

Returns whether the underlying network dataset supports the returning of directions (read-only).

Note: For services prior to ArcGIS 10.8, this value will be Enums.NetworkDirectionsSupportUnknown.

This property was introduced in Esri.ArcGISRuntime 100.7.

See also Enums.NetworkDirectionsSupport.

findBestSequence : bool

Returns whether findBestSequence is true (read-only).

This indicates whether the analysis should reorder stops to find the optimized route. The default is false.

[since Esri::ArcGISRuntime 100.6] maxLocatingDistance : double

Maximum locating distance.

Maximum locating distance is the furthest distance (in meters) that Network Analyst searches when locating or relocating a point onto the network. The search looks for suitable edges or junctions and snaps the point to the nearest one. If a suitable location isn't found within the maximum locating distance, the object is marked as unlocated.

This property was introduced in Esri::ArcGISRuntime 100.6.

networkName : string

Returns the network name (read-only).

outputSpatialReference : SpatialReference

Returns the output spatial reference (read-only).

preserveFirstStop : bool

Returns whether preserveFirstStop is true (read-only).

preserveLastStop : bool

Returns whether preserveLastStop is true (read-only).

restrictionAttributes : jsobject

Returns the restriction attributes as a key-value pair (read-only).

The key is the name as a string, and the value is the RestrictionAttribute.

routeShapeType : Enums.RouteShapeType

Returns the output shape type for a route (read-only).

See also Enums.RouteShapeType.

startTime : date

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

supportedLanguages : list<string>

Returns a list of supported languages for the route directions (read-only).

supportedRestrictionUsageParameterValues : list<string>

Returns a list of supported restriction usage parameter values.

Restrictions can be identified for particular elements such that, during an analysis, traversing restricted elements is prohibited entirely, avoided, or even preferred. The values in this list which are assigned to the restriction usage parameter determines whether the restriction attribute prohibits, avoids, or prefers the network elements it is associated with. Furthermore, the degree to which network elements are avoided or preferred can be defined by choosing High, Medium, or Low.

[since Esri::ArcGISRuntime 100.6] supportsRerouting : bool

Value of service property "Supports Rerouting"

If the "Supports Rerouting" property does not exist on service, then value will be false. For local data, the value will be true.

This property was introduced in Esri::ArcGISRuntime 100.6.

travelModes : list<TravelMode>

Returns a list of travel modes set in the RouteParameters (read-only).

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