Skip To Content ArcGIS for Developers Sign In Dashboard

ServiceAreaTaskInfo QML Type

Information about a ServiceAreaTask. More...

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

Object

Properties

Detailed Description

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

ServiceAreaTaskInfo contains the network dataset defaults from the ServiceAreaTask once it is loaded. Use this class to obtain information about ServiceAreaTask defaults before setting ServiceAreaParameters.

Property Documentation

accumulateAttributeNames : list<string>

Returns the default list of accumulative attribute names (read-only).

For example, accumulateAttributeNames = ["Miles", "Kilometers"] indicates that the total cost of the route should also be calculated in miles and kilometers. All supported attributes can be obtained from ServiceAreaTaskInfo::costAttributes method.

Note: The same list of accumulate attribute names can be obtained from the accumulateAttributeNames method.


costAttributes : jsobject

Returns the map of available cost attributes from the network (read-only).

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


defaultImpedanceCutoffs : list<double>

Returns the default impedance cutoff values (read-only).

Cutoffs specify the quantity of the impedance to apply. They constrain the extent of the service area to be calculated. For example, if you apply breaks of 5, 10, and 15 when the impedance is set to Time, the service area will include those streets than can be reached within 5, 10, and 15 minutes.


defaultTravelModeName : string

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


geometryAtCutoff : Enums.ServiceAreaPolygonCutoffGeometry

Returns the behavior of service area output for a single facility when multiple cutoff values are specified (read-only).

See also Enums.ServiceAreaPolygonCutoffGeometry.


geometryAtOverlap : Enums.ServiceAreaOverlapGeometry

Returns the behavior of service area output from multiple facilities in relation to one another (read-only).

See also Enums.ServiceAreaOverlapGeometry.


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 QML property was introduced in Esri::ArcGISRuntime 100.6.


networkName : string

Returns the network name (read-only).


outputSpatialReference : string

Returns the default output spatial reference (read-only).


polygonBufferDistance : double

Returns the polygon buffer distance in meters (read-only).

The polygon buffer refers to the distance from the road the service area polygon should extend when no other reachable roads are nearby, similar to a line buffer size. This is useful if the network is very sparse and you don't want the service area to cover large areas where there are no features.


polygonDetail : Enums.ServiceAreaPolygonDetail

Returns the level of detail of the output polygons (read-only).

If your analysis covers an urban area with a grid-like street network, the difference between generalized and standard polygons will be minimal. However, for mountain and rural roads, the standard and detailed polygons may present significantly more accurate results than generalized polygons.

See also Enums.ServiceAreaPolygonDetail.


restrictionAttributes : jsobject

Returns the map of available restriction attributes from the network (read-only).

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


returnPolygons : bool

Returns the type of output to be generated (read-only).


returnPolylines : bool

Returns the type of output to be generated (read-only).


startTime : date

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


supportedRestrictionUsageParameterValues : list<string>

Returns the supported values for soft restrictions (read-only).

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


travelDirection : Enums.TravelDirection

Returns the default travel direction type (read-only).

See also Enums.TravelDirection.


travelModes : list<TravelMode>

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



Feedback on this topic?