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)
-
Parameterproperties 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 | Specify if the point barrier restricts travel completely or adds time or distance when it is crossed. more details | PolylineBarrier | |
String | The name of the class. more details | Accessor | |
Point | The point location of the barrier. more details | PolylineBarrier | |
String | The name of the barrier. more details | PolylineBarrier | |
String | 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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
PolylineBarrier | Creates a PolylineBarrier from the parsed Graphic. more details | PolylineBarrier | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | PolylineBarrier | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Graphic | Creates a Graphic from the PolylineBarrier instance. more details | PolylineBarrier | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | PolylineBarrier |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK 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.
Parametergraphic GraphicoptionalA Graphic instance.
ReturnsType 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toGraphic(){Graphic}Since: ArcGIS Maps SDK 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.
ReturnsType 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.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.