A polyline barrier to restrict travel along a street network when using a RouteLayer.
- See also:
// 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
-
new PolylineBarrier(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details Specify if the point barrier restricts travel completely or adds time or distance when it is crossed. | more details | PolylineBarrier | |
String | more details The name of the class. | more details | Accessor | |
Point | more details The point location of the barrier. | more details | PolylineBarrier | |
String | more details The name of the barrier. | more details | PolylineBarrier | |
String | more details For PolylineBarrier the type is always "barrier-line". | more details | PolylineBarrier |
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"
-
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
PolylineBarrier | more details Creates a PolylineBarrier from the parsed Graphic. | more details | PolylineBarrier | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | PolylineBarrier | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Graphic | more details Creates a Graphic from the PolylineBarrier instance. | more details | PolylineBarrier | |
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | PolylineBarrier |
Method Details
-
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 GraphicoptionalA 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 ObjectA 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)inheritedSince: 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.