ServiceAreaFacility QML Type
Represents a service area facility. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
Properties
- curbApproach : Enums.CurbApproach
- currentBearing : double
- currentBearingTolerance : double
- distanceToNetworkLocation : double
- facilityId : int
- geometry : Point
- impedanceCutoffs : list<double>
- locationStatus : Enums.LocationStatus
- name : string
- navigationLatency : double
- navigationSpeed : double
- networkLocation : NetworkLocation
Signals
- curbApproachChanged()
- currentBearingChanged()
- currentBearingToleranceChanged()
- distanceToNetworkLocationChanged()
- facilityIdChanged()
- geometryChanged()
- impedanceCutoffsChanged()
- locationStatusChanged()
- nameChanged()
- navigationLatencyChanged()
- navigationSpeedChanged()
- networkLocationChanged()
Methods
- double addedCost(string attributeName)
- void setAddedCost(string attributeName, double costValue)
Detailed Description
Facilities represent locations from which service areas need to be calculated. For example, a fire station can be set as a facility to find which areas it can serve within a 10 minute service area. A hospital can be set as the facility to find which areas of a city are within a 2-mile driving distance.
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.
| Type | Default Property |
|---|---|
| Point | geometry |
| NetworkLocation | networkLocation |
Property Documentation
curbApproach : Enums.CurbApproach |
The curb approach for this ServiceAreaFacility.
See also Enums.CurbApproach.
[since Esri.ArcGISRuntime 100.7] currentBearing : double |
The current bearing of this ServiceAreaFacility in degrees.
Current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN, negative values will be subtracted from 360 (e.g. -15 => 345), values greater than 360 will be have 360 subtracted from them (e.g. 385 => 25). For this property to be used the bearing tolerance also has to be set.
Bearing and bearing tolerance help to disambiguate how to locate facilities. For example, if you are driving on a freeway overpass and you need to reroute, then you would pass in your device compass bearing and a tolerance (say 45 degrees). This information is used to filter out streets that are potentially closer to your device x,y but are heading in the wrong direction (e.g. An underpass street might be closer to the x,y of your device but it is heading in the wrong direction and would be filtered out).
This property was introduced in Esri.ArcGISRuntime 100.7.
See also currentBearingTolerance.
[since Esri.ArcGISRuntime 100.7] currentBearingTolerance : double |
The current bearing tolerance of this ServiceAreaFacility in degrees.
Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored. Bearing tolerance units are in degrees. Bearing tolerance is plus or minus the currentBearing provided. For example, you could set the currentBearing to 360, to locate streets to the north, and provide a currentBearingTolerance of 45, to find streets plus or minus 45 degrees from north.
This property was introduced in Esri.ArcGISRuntime 100.7.
See also currentBearing.
distanceToNetworkLocation : double |
The distance of this ServiceAreaFacility to a network feature in meters (read-only).
Returns NaN if the ServiceAreaFacility has not been located.
[since Esri.ArcGISRuntime 100.6] facilityId : int |
The ID of this ServiceAreaFacility.
This property was introduced in Esri.ArcGISRuntime 100.6.
geometry : Point |
Returns the geometry indicating where this ServiceAreaFacility is located (read-only).
impedanceCutoffs : list<double> |
The impedance cutoffs of this ServiceAreaFacility.
locationStatus : Enums.LocationStatus |
Returns the LocationStatus of this ServiceAreaFacility (read-only).
See also Enums.LocationStatus.
name : string |
The name of this ServiceAreaFacility.
[since Esri.ArcGISRuntime 100.7] navigationLatency : double |
The navigation latency of this Facility in seconds.
This property was introduced in Esri.ArcGISRuntime 100.7.
[since Esri.ArcGISRuntime 100.7] navigationSpeed : double |
The navigation speed of this Facility in meters-per-second.
This property was introduced in Esri.ArcGISRuntime 100.7.
networkLocation : NetworkLocation |
The network location of this ServiceAreaFacility.
Signal Documentation
curbApproachChanged() |
Emitted when the curbApproach property changes.
Note: The corresponding handler is onCurbApproachChanged.
|
Emitted when the currentBearing property of this ServiceAreaFacility changes.
Note: The corresponding handler is onCurrentBearingChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
|
Emitted when the currentBearingTolerance property of this ServiceAreaFacility changes.
Note: The corresponding handler is onCurrentBearingToleranceChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
distanceToNetworkLocationChanged() |
Emitted when the distanceToNetworkLocation property changes.
Note: The corresponding handler is onDistanceToNetworkLocationChanged.
|
Emitted when the facilityId property of this ServiceAreaFacility changes.
Note: The corresponding handler is onFacilityIdChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
geometryChanged() |
Emitted when the geometry property changes.
Note: The corresponding handler is onGeometryChanged.
impedanceCutoffsChanged() |
Emitted when the impedanceCutoffs property changes.
Note: The corresponding handler is onImpedanceCutoffsChanged.
locationStatusChanged() |
Emitted when the locationStatus property changes.
Note: The corresponding handler is onLocationStatusChanged.
nameChanged() |
Emitted when the name property changes.
Note: The corresponding handler is onNameChanged.
|
Emitted when the navigationLatency property of this ServiceAreaFacility changes.
Note: The corresponding handler is onNavigationLatencyChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
|
Emitted when the navigationSpeed property of this ServiceAreaFacility changes.
Note: The corresponding handler is onNavigationSpeedChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
networkLocationChanged() |
Emitted when the networkLocation property changes.
Note: The corresponding handler is onNetworkLocationChanged.
Method Documentation
double addedCost(string attributeName) |
Returns the added cost of the attribute named attributeName.
See also setAddedCost().
void setAddedCost(string attributeName, double costValue) |
Sets the cost value for the attribute named attributeName to costValue.
See also addedCost().