PolygonBarrier QML Type

  • Esri.ArcGISRuntime
  • PolygonBarrier
  • A polygon barrier object is used to restrict route solving. More...

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

    Object

    Properties

    Signals

    Methods

    Detailed Description

    A class that represents a polygon feature to be avoided (or penalized) by a route. A polygon barrier may represent a regional area of interest within the network to be avoided (i.e., not entered) by a route (e.g., a flood zone) or to penalize/delay a route within any portions of the area traversed by the route (e.g., a busy downtown area or a bad neighborhood).

    The polygon barrier class is derived from the graphic class.

    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.

    TypeDefault Property
    Polygongeometry

    Property Documentation

    [since Esri.ArcGISRuntime 100.6] barrierId : int

    Polygon barrier ID.

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

    This property was introduced in Esri.ArcGISRuntime 100.6.

    See also RouteParameters::setPolygonBarriers, RouteResult::polygonBarriers, ClosestFacilityParameters::setPolygonBarriers, ClosestFacilityResult::polygonBarriers, ServiceAreaParameters::setPolygonBarriers, and ServiceAreaResult::polygonBarriers.


    barrierType : Enums.BarrierType

    The BarrierType of this PolygonBarrier.

    See also Enums.BarrierType.


    [default] geometry : Polygon

    The polygon of this PolygonBarrier.


    [since Esri.ArcGISRuntime 100.3] name : string

    The name of this PolygonBarrier.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.6] barrierIdChanged()

    Emitted when the barrierId property of this PolygonBarrier changes.

    Note: The corresponding handler is onBarrierIdChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.6.


    barrierTypeChanged()

    Emitted when the barrierType property of this PolygonBarrier changes.

    Note: The corresponding handler is onBarrierTypeChanged.


    geometryChanged()

    Emitted when the geometry property of this PolygonBarrier changes.

    Note: The corresponding handler is onGeometryChanged.


    [since Esri.ArcGISRuntime 100.3] nameChanged()

    Emitted when the name property of this PolygonBarrier changes.

    Note: The corresponding handler is onNameChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    Method Documentation

    [since Esri.ArcGISRuntime 200.1] PolygonBarrier clone()

    Creates a deep copy of this object.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    double scaleFactorForCost(string attributeName)

    Returns scale factor for cost of a given attributeName.

    See also setScaleFactorForCost().


    void setScaleFactorForCost(string attributeName, double scaleFactorForCost)

    Sets scale factor for cost.

    • attributeName - The name of attribute.
    • scaleFactorForCost - The scale factor for cost.

    See also scaleFactorForCost().


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