A polygon barrier object is used to restrict route solving. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 100.0 |
Inherits: |
- List of all members, including inherited members
- PolygonBarrier is part of QML Type List.
Properties
- barrierId : int
- barrierType : Enums.BarrierType
- geometry : Polygon
- name : string
Signals
Methods
- PolygonBarrier clone()
- double scaleFactorForCost(string attributeName)
- void setScaleFactorForCost(string attributeName, double scaleFactorForCost)
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.
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
|
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
.
|
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
|
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().