PointBarrier

Property Overview

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"

curbApproach String

The side of the vehicle the curb is on when arriving at the stop.

Possible Values:"either-side-of-vehicle"|"right-side-of-vehicle"|"left-side-of-vehicle"|"no-u-turn"

declaredClass Stringreadonly inherited

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

fullEdge String

Point barriers are applied to the edge elements during the analysis. A value of "permit" means that travel is permitted on the edge up to the barrier, but not through it. A value of "restrict" means that travel is restricted anywhere on the associated edge.

Possible Values:"permit"|"restrict"

geometry Point

The point location of the barrier.

name String

The name of the barrier.

type Stringreadonly

For PointBarrier the type is always "barrier-point".

Method Overview

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){PointBarrier}static

Since: ArcGIS API for JavaScript 4.24

Creates a PointBarrier 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
PointBarrier	A PointBarrier 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 PointBarrier 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.