PolylineBarrier

// 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)

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"

declaredClass Stringreadonly inherited

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

geometry Point

The point location of the barrier.

name String

The name of the barrier.

type Stringreadonly

For PolylineBarrier the type is always "barrier-line".

Method Overview

Method Details

fromGraphic(graphic){PolylineBarrier}static

Since: ArcGIS API for JavaScript 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(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.

own(handleOrHandles)inherited

Since: ArcGIS API for JavaScript 4.24

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.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));

Parameter:

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

toGraphic(){Graphic}

Since: ArcGIS API for JavaScript 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(){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.