ServiceAreaFacility QML Type

  • Esri.ArcGISRuntime
  • ServiceAreaFacility
  • Represents a service area facility. More...

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

    Object

    Properties

    Signals

    Methods

    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.

    Property Documentation

    curbApproach : Enums.CurbApproach

    The curb approach for this ServiceAreaFacility.

    Default value Enums.CurbApproachEitherSide will be returned on error.


    [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

    Current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.

    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.


    [read-only] distanceToNetworkLocation : double

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

    The distance to network location in meters can be populated by service area task.

    Returns NaN if the ServiceAreaFacility has not been located.


    [since Esri.ArcGISRuntime 100.6] facilityId : int

    The ID of this ServiceAreaFacility.

    This is a caller supplied foreign key that can be used to associate output facilities with input facilities.

    This property was introduced in Esri.ArcGISRuntime 100.6.

    See also ServiceAreaParameters::setFacilities and ServiceAreaResult::facilities.


    geometry : Point

    Returns the geometry indicating where this ServiceAreaFacility is located (read-only).


    impedanceCutoffs : list<double>

    The impedance cutoffs value.

    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 that can be reached within 5, 10, and 15 minutes. The value specified in the impedance cutoffs property overrides the Default Cutoffs analysis setting. If no value for the impedance cutoffs property is specified, service area are generated for the facility based on the Default Cutoffs setting.


    [read-only] locationStatus : Enums.LocationStatus

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

    Facility location's status can be populated by service area task. Default value Enums.LocationStatusNotLocated will be returned on error.


    name : string

    The name of this ServiceAreaFacility.


    The navigation latency of this Facility in seconds.

    This property was introduced in Esri.ArcGISRuntime 100.7.


    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.

    The service area facility's location on the network that can be populated by service area task. Set to null for resetting a network location.


    Signal Documentation

    curbApproachChanged()

    Emitted when the curbApproach property changes.

    Note: The corresponding handler is onCurbApproachChanged.


    [since Esri.ArcGISRuntime 100.7] currentBearingChanged()

    Emitted when the currentBearing property of this ServiceAreaFacility changes.

    Note: The corresponding handler is onCurrentBearingChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.7.


    [since Esri.ArcGISRuntime 100.7] currentBearingToleranceChanged()

    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.


    [since Esri.ArcGISRuntime 100.6] facilityIdChanged()

    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.

    Returns added cost value for given impedance or accumulate attribute

    See also setAddedCost().


    [since Esri.ArcGISRuntime 200.1] ServiceAreaFacility clone()

    Creates a deep copy of this object.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    void setAddedCost(string attributeName, double costValue)

    Sets added cost.

    • attributeName - The name of attribute.
    • costValue - The added cost.

    Sets added cost value for given impedance or accumulate attribute.

    See also addedCost().


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.