PointBarrier | API Reference | ArcGIS Maps SDK for JavaScript 4.33

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

See also

Constructors

PointBarrier Constructor new PointBarrier(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String\|null\|undefined	Specify if the point barrier restricts travel completely or adds time or distance when it is crossed.	PointBarrier
String\|null\|undefined	The direction of traffic that is affected by the barrier.	PointBarrier
String	The name of the class.	Accessor
String\|null\|undefined	Point barriers are applied to the edge elements during the analysis.	PointBarrier
Point\|null\|undefined	The point location of the barrier.	PointBarrier
String\|null\|undefined	The name of the barrier.	PointBarrier
PopupTemplate\|null\|undefined	The template for displaying content in a Popup when the graphic is selected.	PointBarrier
String	For PointBarrier the type is always "point-barrier".	PointBarrier

Property Details

barrierType Property barrierType String |null |undefined

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

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

See also

BarrierType

curbApproach Property curbApproach String |null |undefinedreadonly

The direction of traffic that is affected by the barrier.

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

See also

CurbApproach

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

fullEdge Property fullEdge String |null |undefined

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 Property geometry Point |null |undefinedautocast

The point location of the barrier.

name Property name String |null |undefined

The name of the barrier.

popupTemplate Property popupTemplate PopupTemplate |null |undefinedautocast Since: ArcGIS Maps SDK for JavaScript 4.30 PointBarrier since 4.23, popupTemplate added at 4.30.

The template for displaying content in a Popup when the graphic is selected.

type Property type Stringreadonly

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

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
PointBarrier	Creates a PointBarrier from the parsed Graphic.	PointBarrier
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	PointBarrier
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Graphic	Creates a Graphic from the PointBarrier instance.	PointBarrier
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	PointBarrier

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor 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

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 Method fromGraphic(graphic){PointBarrier}static Since: ArcGIS Maps SDK for JavaScript 4.24 PointBarrier since 4.23, fromGraphic added at 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 Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor 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 *

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 Inherited Method removeHandles(groupKey) Inherited from Accessor 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 *

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 Method toGraphic(){Graphic} Since: ArcGIS Maps SDK for JavaScript 4.24 PointBarrier since 4.23, toGraphic added at 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 Method 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.