ESM: import PolygonBarrier from "@arcgis/core/rest/support/PolygonBarrier.js";
CDN: const PolygonBarrier = await $arcgis.import("@arcgis/core/rest/support/PolygonBarrier.js");
Class: @arcgis/core/rest/support/PolygonBarrier
Since: ArcGIS Maps SDK for JavaScript 4.23
A polygon barrier to restrict travel along a street network when using a RouteLayer.
new PolygonBarrier(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsUse 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"
Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
The point location of the barrier.
Since: ArcGIS Maps SDK for JavaScript 4.30 PolygonBarrier since 4.23, popupTemplate added at 4.30.
The template for displaying content in a Popup when the graphic is selected.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
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.
Since: ArcGIS Maps SDK for JavaScript 4.24 PolygonBarrier 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.
Parameter
optionalA Graphic instance.
Returns
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 json
parameter 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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
if 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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toGraphic(){Graphic}
Since: ArcGIS Maps SDK for JavaScript 4.24 PolygonBarrier 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.
Returns
Type Description Graphic A Graphic instance.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4