ServiceAreaParameters QML Type

  • Esri.ArcGISRuntime
  • ServiceAreaParameters
  • A class that describes the service area parameters. More...

    Import Statement: import Esri.ArcGISRuntime
    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.

    Class holding the parameters of a service area to be solved by ServiceAreaTask. The default parameters for a ServiceAreaTask can be retrieved by calling ServiceAreaTask::createDefaultParameters method.

    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.

    Property Documentation

    accumulateAttributeNames : list<string>

    The list of attributes to accumulate.

    The accumulate attribute names e.g. "Minutes", "Miles", etc. Accumulate attributes are useful when more information other than the default impedance attribute is required.

    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.

    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 cutoffs you specify in the defaultBreaks property are applied to all facilities that don't contain their own cutoffs.


    geometryAtCutoff : Enums.ServiceAreaPolygonCutoffGeometry

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

    Specifies the behavior of service area output for a single facility when multiple cutoff values are specified. This parameter does not apply to line output. Default value Enums.ServiceAreaPolygonCutoffGeometryRings will be returned on error.


    geometryAtOverlap : Enums.ServiceAreaOverlapGeometry

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

    Specifies the behavior of service-area output from multiple facilities in relation to one another. Default value Enums.ServiceAreaOverlapGeometryOverlap will be returned on error.


    outputSpatialReference : SpatialReference

    The output spatial reference.

    All route's geometries will be returned in this spatial reference in the even of a successful solve.


    polygonBufferDistance : double

    The polygon buffer distance in meters.

    The polygon buffer refers to the distance from the road the service area polygon should extend when no other reachable roads are nearby, similar to a line buffer size. This is useful if the network is very sparse and you don't want the service area to cover large areas where there are no features.


    polygonDetail : Enums.ServiceAreaPolygonDetail

    The level of detail of the output polygons.

    Specifies the level of detail of the output polygons. If your analysis covers an urban area with a grid-like street network, the difference between generalized and standard polygons will be minimal. However, for mountain and rural roads, the standard and detailed polygons may present significantly more accurate results than generalized polygons. Default value Enums.ServiceAreaPolygonDetailStandard will be returned on error.


    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.

    Enabled by default. Can be returned in the ServiceAreaResult of a successful solve.


    returnPolylineBarriers : bool

    Whether to return polyline barriers in the result.

    Reusing the PolylineBarriers from the ServiceAreaResult (as opposed to using the original 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.

    Disabled by default. Can be returned in the ServiceAreaResult of a successful solve.


    startTime : date

    The start time of the route in UTC time.

    Returns null if start time was not specified


    travelDirection : Enums.TravelDirection

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

    Default value Enums.TravelDirectionFromFacility will be returned on error.


    travelMode : TravelMode

    The travel mode for a service area.

    Travel mode that will be used for service area's solving. List of supported travel modes can be obtained from ServiceAreaTaskInfo::travelModes method.


    Signal Documentation

    accumulateAttributeNamesChanged()

    Emitted when the accumulateAttributeNames property changes.

    Note: The corresponding handler is onAccumulateAttributeNamesChanged.


    defaultImpedanceCutoffsChanged()

    Emitted when the defaultImpedanceCutoffs property changes.

    Note: The corresponding handler is onDefaultImpedanceCutoffsChanged.


    geometryAtCutoffChanged()

    Emitted when the geometryAtCutoff property changes.

    Note: The corresponding handler is onGeometryAtCutoffChanged.


    geometryAtOverlapChanged()

    Emitted when the geometryAtOverlap property changes.

    Note: The corresponding handler is onGeometryAtOverlapChanged.


    outputSpatialReferenceChanged()

    Emitted when the outputSpatialReference property changes.

    Note: The corresponding handler is onOutputSpatialReferenceChanged.


    polygonBufferDistanceChanged()

    Emitted when the polygonBufferDistance property changes.

    Note: The corresponding handler is onPolygonBufferDistanceChanged.


    polygonDetailChanged()

    Emitted when the polygonDetail property changes.

    Note: The corresponding handler is onPolygonDetailChanged.


    returnPointBarriersChanged()

    Emitted when the returnPointBarriers property changes.

    Note: The corresponding handler is onReturnPointBarriersChanged.


    returnPolygonBarriersChanged()

    Emitted when the returnPolygonBarriers property changes.

    Note: The corresponding handler is onReturnPolygonBarriersChanged.


    returnPolygonsChanged()

    Emitted when the returnPolygons property changes.

    Note: The corresponding handler is onReturnPolygonsChanged.


    returnPolylineBarriersChanged()

    Emitted when the returnPolylineBarriers property changes.

    Note: The corresponding handler is onReturnPolylineBarriersChanged.


    returnPolylinesChanged()

    Emitted when the returnPolylines property changes.

    Note: The corresponding handler is onReturnPolylinesChanged.


    startTimeChanged()

    Emitted when the startTime property changes.

    Note: The corresponding handler is onStartTimeChanged.


    travelDirectionChanged()

    Emitted when the travelDirection property changes.

    Note: The corresponding handler is onTravelDirectionChanged.


    travelModeChanged()

    Emitted when the travelMode property changes.

    Note: The corresponding handler is onTravelModeChanged.


    Method Documentation

    void clearFacilities()

    Clears the facilities that have been set on this ServiceAreaParameters::setFacilities().

    Clears facilities that were set by setFacilities.


    void clearPointBarriers()

    Clears point barriers that were set by ServiceAreaParameters::setPointBarriers().

    Clears point barriers that were set by setPointBarriers.


    void clearPolygonBarriers()

    Clears the polygon barriers that have been set by ServiceAreaParameters::setPolygonBarriers().

    Clears polygon barriers that were set by setPolygonBarriers.


    void clearPolylineBarriers()

    Clears the polyline barriers that have been set on this ServiceAreaParameters::setPolylineBarriers().

    Clears polyline barriers that were set by setPolylineBarriers.


    [since Esri.ArcGISRuntime 200.1] ServiceAreaParameters clone()

    Creates a deep copy of this object.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    [since Esri.ArcGISRuntime 100.6] string searchWhereClause(string sourceName)

    Gets the search where clause from the specified network dataset's source feature class.

    • sourceName - The name of the network dataset's source feature class to retrieve the where clause from.

    This method was introduced in Esri.ArcGISRuntime 100.6.

    See also setSearchWhereClause().


    void setFacilities(list<ServiceAreaFacility> facilities)

    Sets facilities.

    The set of service area facilities loaded as network locations during analysis. You need to specify at least one facility to successfully ServiceAreaTask::solveServiceArea(ServiceAreaParameters).


    void setFacilitiesWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

    Sets the facilities from the features in specified feature table. The feature table can be either local or online.

    The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the facilities objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.

    • featureTable - The feature table.
    • queryParameters - The query parameters.

    Sets facilities by importing them from local or remote table.

    See also FeatureTable.


    void setPointBarriers(list<PointBarriers> pointBarriers)

    Sets point barriers.

    • pointBarriers - A list of PointBarrier instances. Contents of the list are copied.

    void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

    Sets the point barriers from the features in specified feature table.

    The feature table can be either local or online. The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.

    • featureTable - The feature table.
    • queryParameters - The query parameters.

    Sets point barriers by importing them from local or remote table.

    See also FeatureTable.


    void setPolygonBarriers(list<PolygonBarriers> polygonBarriers)

    Sets polygon barriers.

    • polygonBarriers - A list of PolygonBarrier instances. Contents of the list are copied.

    void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

    Sets the polygon barriers from the features in specified feature table.

    The feature table can be either local or online. The feature table must be of geometry type polygon. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.

    • featureTable - The feature table.
    • queryParameters - The query parameters.

    Sets polygon barriers by importing them from local or remote table.

    See also FeatureTable.


    void setPolylineBarriers(list<PolylineBarriers> polylineBarriers)

    Sets polyline barriers.

    • polylineBarriers - A list of PolylineBarrier instances. Contents of the list are copied.

    void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)

    Sets the polyline barriers from the features in specified feature table.

    The feature table can be either local or online. The feature table must be of geometry type polyline. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.

    • featureTable - The feature table.
    • queryParameters - The query parameters.

    Sets polyline barriers by importing them from local or remote table.

    See also FeatureTable.


    [since Esri.ArcGISRuntime 100.6] void setSearchWhereClause(string sourceName, string searchWhereClause)

    Sets a search where clause on the specified network dataset's source feature class.

    Only features satisfying the where clause for the specified feature class will be used to locate facilities on the network during the solve operation. If a where clause is not set all network features are used.

    • sourceName - The name of the network dataset's source feature class the where clause will be applied to.
    • searchWhereClause - The search where clause.

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

    This method was introduced in Esri.ArcGISRuntime 100.6.

    See also searchWhereClause().


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