Skip To Content ArcGIS for Developers Sign In Dashboard

Facility QML Type

A facility used with a closest facility task. More...

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

Object

Properties

Signals

Methods

Detailed Description

Facilities represent locations that can serve as the starting point or ending point of a closest facility analysis, such as a fire station or a hospital. ClosestFacilityParameters contain a list of Facility objects. The ClosestFacilityTask creates routes between facilities and incidents.

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

curbApproach : Enums.CurbApproach

The curb approach for this Facility.

See also Enums.CurbApproach.


distanceToNetworkLocation : double

The distance of this Facility to a network feature in meters (read-only).

Returns NaN if the facility has not been located.


facilityId : int

The ID of this Facility.

This QML property was introduced in Esri.ArcGISRuntime 100.6.


geometry : Point

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


impedanceCutoff : double

The Impedance Cutoff of this Facility.

For instance, while finding the closest hospitals from the site of an accident, a cutoff value of 15 minutes would mean that the closest facility task would search for the closest hospital within 15 minutes from the incident. If the closest hospital is 17 minutes away, no routes will be returned in the output routes. A cutoff value is especially useful when searching for multiple facilities or incidents. The units for impedance cutoff is based on the value of the TravelMode.impedanceAttributeName. For example, if TravelMode.impedanceAttributeName is TravelTime, then impedanceCutoff is specified in minutes.


locationStatus : Enums.LocationStatus

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

See also Enums.LocationStatus.


name : string

The name of the Facility.


networkLocation : NetworkLocation

The network location of this Facility.


Signal Documentation

curbApproachChanged()

Emitted when the curbApproach property of this Facility changes.


distanceToNetworkLocationChanged()

Emitted when the distanceToNetworkLocation property of this Facility changes.


facilityIdChanged()

Emitted when the facilityId property of this Facility changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.6.


geometryChanged()

Emitted when the geometry property of this Facility changes.


impedanceCutoffChanged()

Emitted when the impedanceCutoff property of this Facility changes.


locationStatusChanged()

Emitted when the locationStatus property of this Facility changes.


nameChanged()

Emitted when the name property of this Facility changes.


networkLocationChanged()

Emitted when the networkLocation property of this Facility changes.


Method Documentation

double addedCost(string attributeName)

Returns the added cost of a given attributeName.


void setAddedCost(string attributeName, double costValue)

Sets the costValue for a given attributeName.



Feedback on this topic?