Skip To Content ArcGIS for Developers Sign In Dashboard

ClosestFacilityParameters QML Type

Parameters for a ClosestFacilityTask, such as facilities, incidents, barriers, and whether to return directions. More...

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

Object

Properties

Signals

Methods

Detailed Description

Facilities, incidents and barriers must have the same spatial reference, but do not need to be reprojected to match the network dataset's spatial reference. For example, the network dataset could be in WKID 4326, and your map, facilities, incidents and barriers could all be in WKID 3857. The ClosestFacilityTask will automatically reproject the facilities, incidents and barriers, and output the ClosestFacilityRoute in whatever output spatial reference is specified.

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

See also ClosestFacilityTask::createDefaultParameters.

Property Documentation

accumulateAttributeNames : list<string>

The accumulateAttributeNames of the ClosestFacilityParameters.


defaultImpedanceCutoff : double

The default cutoff value to stop traversing.

The units for impedance cutoff is based on the value of the TravelMode.impedanceAttributeName. For example, if TravelMode.impedanceAttributeName parameter is TravelTime, the defaultImpedanceCutoff is specified in minutes.


defaultTargetFacilityCount : int

The default number of facilities to find.


directionsDistanceUnits : Enums.UnitSystem

The units in which the length information will be reported in the route directions.

See also Enums.UnitSystem.


directionsLanguage : string

The language of the resulting route directions.


directionsStyle : Enums.DirectionsStyle

The style of the resulting route directions.

See also Enums.DirectionsStyle.


outputSpatialReference : SpatialReference

The output spatial reference.


returnDirections : bool

The returnDirections of the ClosestFacilityParameters.


returnPointBarriers : bool

The returnPointBarriers of the ClosestFacilityParameters.

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


returnPolygonBarriers : bool

The returnPolygonBarriers of the ClosestFacilityParameters.

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


returnPolylineBarriers : bool

The returnPolylineBarriers of the ClosestFacilityParameters.

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


returnRoutes : bool

The returnRoutes of the ClosestFacilityParameters.


routeShapeType : Enums.RouteShapeType

The output shape type for a closest facility.

See also Enums.RouteShapeType.


startTime : date

The start time of the route in UTC time.


startTimeUsage : Enums.StartTimeUsage

The startTimeUsage of the ClosestFacilityParameters.

See also Enums.StartTimeUsage.


travelDirection : Enums.TravelDirection

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

See also Enums.TravelDirection.


travelMode : TravelMode

The travel mode for a closest facility.


Signal Documentation

accumulateAttributeNamesChanged()

Emitted when the accumulateAttributeNames property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onAccumulateAttributeNamesChanged.


defaultImpedanceCutoffChanged()

Emitted when the defaultImpedanceCutoff property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onDefaultImpedanceCutoffChanged.


defaultTargetFacilityCountChanged()

Emitted when the defaultTargetFacilityCount property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onDefaultTargetFacilityCountChanged.


directionsDistanceUnitsChanged()

Emitted when the directionsDistanceUnits property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onDirectionsDistanceUnitsChanged.


directionsLanguageChanged()

Emitted when the directionsLanguage property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onDirectionsLanguageChanged.


directionsStyleChanged()

Emitted when the directionsStyle property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onDirectionsStyleChanged.


outputSpatialReferenceChanged()

Emitted when the outputSpatialReference property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onOutputSpatialReferenceChanged.


returnDirectionsChanged()

Emitted when the returnDirections property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onReturnDirectionsChanged.


returnPointBarriersChanged()

Emitted when the returnPointBarriers property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onReturnPointBarriersChanged.


returnPolygonBarriersChanged()

Emitted when the returnPolygonBarriers property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onReturnPolygonBarriersChanged.


returnPolylineBarriersChanged()

Emitted when the returnPolylineBarriers property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onReturnPolylineBarriersChanged.


returnRoutesChanged()

Emitted when the returnRoutes property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onReturnRoutesChanged.


routeShapeTypeChanged()

Emitted when the routeShapeType property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onRouteShapeTypeChanged.


startTimeChanged()

Emitted when the startTime property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onStartTimeChanged.


startTimeUsageChanged()

Emitted when the startTimeUsage property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onStartTimeUsageChanged.


travelDirectionChanged()

Emitted when the travelDirection property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onTravelDirectionChanged.


travelModeChanged()

Emitted when the travelMode property of this ClosestFacilityParameters changes.

Note: The corresponding handler is onTravelModeChanged.


Method Documentation

void clearFacilities()

Clears facilities that were set by ClosestFacilityParameters::setFacilities()


void clearIncidents()

Clears incidents that were set by setIncidents().


void clearPointBarriers()

Clears point barriers that were set by setPointBarriers().


void clearPolygonBarriers()

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


void clearPolylineBarriers()

Clears polyline barriers that were set by ClosestFacilityParameters::setPolylineBarriers().


string searchWhereClause(sourceName)

Returns the search WHERE clause from the specified sourceName.

See also setSearchWhereClause().


void setFacilities(facilities)

Sets the facilities for a ClosestFacilityTask by providing a list of Facilities.


void setFacilitiesWithFeatureTable(featureTable, QueryParameters queryParameters)

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


void setIncidents(incidents)

Sets the incidents for a ClosestFacilityTask by providing a list of Incidents.


void setIncidentsWithFeatureTable(featureTable, QueryParameters queryParameters)

Sets the incidents for a ClosestFacilityTask by providing a featureTable filtered with queryParameters.


void setPointBarriers(pointBarriers)

Sets the pointBarriers for a ClosestFacilityTask by providing a list of PointBarriers.


void setPointBarriersWithFeatureTable(featureTable, QueryParameters queryParameters)

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


void setPolygonBarriers(polygonBarriers)

Sets the polygonBarriers for a ClosestFacilityTask by providing a list of PolygonBarriers.


void setPolygonBarriersWithFeatureTable(featureTable, QueryParameters queryParameters)

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


void setPolylineBarriers(polylineBarriers)

Sets the polylineBarriers for a ClosestFacilityTask by providing a list of PolylineBarriers.


void setPolylineBarriersWithFeatureTable(featureTable, QueryParameters queryParameters)

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


void setSearchWhereClause(sourceName, string searchWhereClause)

Sets the searchWhereClause for the specified sourceName.

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

See also searchWhereClause().



Feedback on this topic?