PolylineBarrier | API Reference | ArcGIS Maps SDK for JavaScript 4.33

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

See also

Example

// Print the number of polyline barriers.
const routeLayer = new RouteLayer({
  portalItem: {
    id: "69569b47b1e445b8a42ec12feab41ce9"
  }
});
await routeLayer.load();

const count = routeLayer.polylineBarriers.length;
console.log(`The route contains ${count} linear barriers`);
// output: "The route contains 2 linear barriers"

// Zoom to first barrier
view.goTo(routeLayer.polylineBarriers[0].geometry)

Constructors

PolylineBarrier Constructor new PolylineBarrier(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 whether the barrier restricts travel completely or scales time or distance when it is crossed.	PolylineBarrier
String	The name of the class.	Accessor
Polyline\|null\|undefined	The point location of the barrier.	PolylineBarrier
String\|null\|undefined	The name of the barrier.	PolylineBarrier
PopupTemplate\|null\|undefined	The template for displaying content in a Popup when the graphic is selected.	PolylineBarrier
String	For PolylineBarrier the type is always "polyline-barrier".	PolylineBarrier

Property Details

barrierType Property barrierType String |null |undefined

Specify whether the barrier restricts travel completely or scales time or distance when it is crossed.

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

See also

BarrierType

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

geometry Property geometry Polyline |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 PolylineBarrier 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 PolylineBarrier the type is always "polyline-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
PolylineBarrier	Creates a PolylineBarrier from the parsed Graphic.	PolylineBarrier
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	PolylineBarrier
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 PolylineBarrier instance.	PolylineBarrier
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	PolylineBarrier

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){PolylineBarrier}static Since: ArcGIS Maps SDK for JavaScript 4.24 PolylineBarrier since 4.23, fromGraphic added at 4.24.

Creates a PolylineBarrier 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
PolylineBarrier	A PolylineBarrier 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 PolylineBarrier since 4.23, toGraphic added at 4.24.

Creates a Graphic from the PolylineBarrier 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.