Skip To Content ArcGIS for Developers Sign In Dashboard

ServiceAreaParameters QML Type

Represents input parameters for computing service area using ServiceAreaTask. More...

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

Object

Properties

Signals

Methods

Detailed Description

The ServiceAreaParameters class contains all inputs for the ServiceAreaTask, as well as settings such as the facilities, impedance attribute, accumulate and restriction attributes, backtrack (U-turn) policy, etc.

Note: You cannot declare or create a component of this type in QML code. The standard pattern is to retrieve one from the ServiceAreaTask type so it already contain defaults values necessary for solving service area.

See also ServiceAreaTask::createDefaultParameters.

Property Documentation

accumulateAttributeNames : list<string>

The list of attributes to accumulate.

Use this parameter to specify if the service should accumulate values other than the value specified as the impedanceAttributeName when generating service area lines. For example, you might want to generate service area lines based on travel distance and accumulate travel time. The service area lines are based on distance, but they also specify how long it would take to reach a portion of the service area.


defaultImpedanceCutoffs : list<double>

The default impedance cutoffs.


geometryAtCutoff : Enums.ServiceAreaPolygonCutoffGeometry

The behavior of service area output for a single facility when multiple cutoff values are specified.

See also Enums.ServiceAreaPolygonCutoffGeometry.


geometryAtOverlap : Enums.ServiceAreaOverlapGeometry

The behavior of service area output from multiple facilities in relation to one another.

See also Enums.ServiceAreaOverlapGeometry.


outputSpatialReference : SpatialReference

The output spatial reference.


polygonBufferDistance : double

The polygon buffer distance in meters.


polygonDetail : Enums.ServiceAreaPolygonDetail

The level of detail of the output polygons.

See also Enums.ServiceAreaPolygonDetail.


returnPointBarriers : bool

Whether to return point barriers in the result.

Reusing the PointBarriers from the ServiceAreaResult (as opposed to using the original PointBarriers) can increase the speed of any subsequent route calculations.


returnPolygonBarriers : bool

Whether to return polygon barriers in the result.

Reusing the PolygonBarriers from the ServiceAreaResult (as opposed to using the original PolygonBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polygons.


returnPolygons : bool

Whether to return the results as polygons.


returnPolylineBarriers : bool

Whether to return polyline barriers in the result.

Reusing the /l {PolylineBarrier} {PolylineBarriers} from the ServiceAreaResult (as opposed to using the original /l {PolylineBarrier} {PolylineBarriers}) can increase the speed of any subsequent route calculations. This is particularly true for complex polylines.


returnPolylines : bool

Whether to return the results as polylines.


startTime : date

The start time of the route in UTC time.


travelDirection : Enums.TravelDirection

The travel direction (to or away from the facility).

See also Enums.TravelDirection.


travelMode : TravelMode

The travel mode for a service area.


Signal Documentation

accumulateAttributeNamesChanged()

Emitted when the accumulateAttributeNames property changes.


defaultImpedanceCutoffsChanged()

Emitted when the defaultImpedanceCutoffs property changes.


geometryAtCutoffChanged()

Emitted when the geometryAtCutoff property changes.


geometryAtOverlapChanged()

Emitted when the geometryAtOverlap property changes.


outputSpatialReferenceChanged()

Emitted when the outputSpatialReference property changes.


polygonBufferDistanceChanged()

Emitted when the polygonBufferDistance property changes.


polygonDetailChanged()

Emitted when the polygonDetail property changes.


returnPointBarriersChanged()

Emitted when the returnPointBarriers property changes.


returnPolygonBarriersChanged()

Emitted when the returnPolygonBarriers property changes.


returnPolygonsChanged()

Emitted when the returnPolygons property changes.


returnPolylineBarriersChanged()

Emitted when the returnPolylineBarriers property changes.


returnPolylinesChanged()

Emitted when the returnPolylines property changes.


startTimeChanged()

Emitted when the startTime property changes.


travelDirectionChanged()

Emitted when the travelDirection property changes.


travelModeChanged()

Emitted when the travelMode property changes.


Method Documentation

void clearFacilities()

Clears the facilities that have been set on this ServiceAreaParameters.


void clearPointBarriers()

Clears the point barriers that have been set on this ServiceAreaParameters.


void clearPolygonBarriers()

Clears the polygon barriers that have been set on this ServiceAreaParameters.


void clearPolylineBarriers()

Clears the polyline barriers that have been set on this ServiceAreaParameters.


string searchWhereClause(string sourceName)

Returns the search WHERE clause from the specified sourceName.

This QML method was introduced in Esri.ArcGISRuntime 100.6.


void setFacilities(list<ServiceAreaFacility> facilities)

Sets the list of facilities of this ServiceAreaTask to facilities.


void setFacilitiesWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

Sets the facilities for a ServiceAreaTask by providing a featureTable filtered with queryParameters.


void setPointBarriers(list<PointBarriers> pointBarriers)

Sets the list of point barriers of this ServiceAreaParameters to pointBarriers.


void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

Sets the point barriers for a ServiceAreaTask by providing a featureTable filtered with queryParameters.


void setPolygonBarriers(list<PolygonBarriers> polygonBarriers)

Sets the list of polygon barriers of this ServiceAreaParameters to polygonBarriers.


void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

Sets the polygon barriers for a ServiceAreaTask by providing a featureTable filtered with queryParameters.


void setPolylineBarriers(list<PolylineBarriers> polygonBarriers)

Sets the list of polyline barriers of this ServiceAreaParameters to polylineBarriers.


void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

Sets the polyline barriers for a ServiceAreaTask by providing a featureTable filtered with queryParameters.


void setSearchWhereClause(string sourceName, string searchWhereClause)

Sets the searchWhereClause for the specified sourceName.

This filters the potential matches returned from the task based on an expression.

Note: Search WHERE clauses are not supported for online service area tasks. They are only supported when solving local service area tasks.

This QML method was introduced in Esri.ArcGISRuntime 100.6.



Feedback on this topic?