PolygonBarrier

AMD: require(["esri/rest/support/PolygonBarrier"], (PolygonBarrier) => { /* code goes here */ });
ESM: import PolygonBarrier from "@arcgis/core/rest/support/PolygonBarrier";
Class: esri/rest/support/PolygonBarrier
Inheritance: PolygonBarrier Accessor
Since: ArcGIS API for JavaScript 4.23

A polygon barrier to restrict travel along a street network when using a RouteLayer.

See also

Constructors

new PolygonBarrier(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

Specify if the point barrier restricts travel completely or adds time or distance when it is crossed.

more details
PolygonBarrier
String

The name of the class.

more details
Accessor
Polygon

The point location of the barrier.

more details
PolygonBarrier
String

The name of the barrier.

more details
PolygonBarrier
String For PolygonBarrier the type is always "barrier-area". more detailsPolygonBarrier

Property Details

barrierType String

Specify if the point barrier restricts travel completely or adds time or distance when it is crossed.

Possible Values:"restriction"|"added-cost"

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

geometry Polygon

The point location of the barrier.

name String

The name of the barrier.

type Stringreadonly

For PolygonBarrier the type is always "barrier-area".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
PolygonBarrier

Creates a PolygonBarrier from the parsed Graphic.

more details
PolygonBarrier
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
PolygonBarrier
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Graphic

Creates a Graphic from the PolygonBarrier instance.

more details
PolygonBarrier
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
PolygonBarrier

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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(graphic){PolygonBarrier}static
Since: ArcGIS API for JavaScript 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
graphic Graphic
optional

A Graphic instance.

Returns
Type Description
PolygonBarrier A PolygonBarrier instance.
fromJSON(json){*}static

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.

Parameter
json Object

A 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.

Returns
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A 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 API for JavaScript 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.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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