require(["esri/rest/support/PolygonBarrier"], (PolygonBarrier) => { /* code goes here */ });
import PolygonBarrier from "@arcgis/core/rest/support/PolygonBarrier.js";
esri/rest/support/PolygonBarrier
A polygon barrier to restrict travel along a street network when using a RouteLayer.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons. | PolygonBarrier | ||
The name of the class. | Accessor | ||
The point location of the barrier. | PolygonBarrier | ||
The name of the barrier. | PolygonBarrier | ||
The template for displaying content in a Popup when the graphic is selected. | PolygonBarrier | ||
| For PolygonBarrier the type is always "polygon-barrier". | PolygonBarrier |
Property Details
-
barrierType
PropertybarrierType String -
Use this parameter to specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.
Possible Values:"added-cost" |"restriction" |"scaled-cost"
- See also
-
geometry
Propertygeometry Polygon -
The point location of the barrier.
-
name
Propertyname String -
The name of the barrier.
-
popupTemplate
PropertypopupTemplate PopupTemplateautocastSince: ArcGIS Maps SDK for JavaScript 4.30PolygonBarrier since 4.23, popupTemplate added at 4.30. -
The template for displaying content in a Popup when the graphic is selected.
-
type
Propertytype Stringreadonly -
For PolygonBarrier the type is always "polygon-barrier".
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a PolygonBarrier from the parsed Graphic. | PolygonBarrier | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | PolygonBarrier | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Creates a Graphic from the PolygonBarrier instance. | PolygonBarrier | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | PolygonBarrier |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
fromGraphic
MethodfromGraphic(graphic){PolygonBarrier}staticSince: ArcGIS Maps SDK for JavaScript 4.24PolygonBarrier since 4.23, fromGraphic added at 4.24. -
Creates a PolygonBarrier from the parsed Graphic. The method assumes that the graphic's attributes conform to the route layer item schema.
Parametergraphic GraphicoptionalA Graphic instance.
ReturnsType Description PolygonBarrier A PolygonBarrier instance.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toGraphic
MethodtoGraphic(){Graphic}Since: ArcGIS Maps SDK for JavaScript 4.24PolygonBarrier since 4.23, toGraphic added at 4.24. -
Creates a Graphic from the PolygonBarrier instance. The resulting graphic will have attributes that conform to the route layer item schema.
ReturnsType Description Graphic A Graphic instance.
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.