CircuitPath | API Reference | ArcGIS Maps SDK for JavaScript

Represents a path in the telecom domain network. Paths are returned by path and circuit traces in a telecom domain network.

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	The name of the class.	Accessor
Polyline\|null\|undefined	The geometry of the path, if the trace `resultTypes` includes geometry.	CircuitPath
Number\|null\|undefined	The unique identifier for the path's order.	CircuitPath
CircuitPathConnectivityElement []	The edges and junctions that constitute the path.	CircuitPath
Number\|null\|undefined	The unique identifier for the path.	CircuitPath
TraceLocation	The starting location for the path.	CircuitPath
TraceLocation	The stopping location for the path.	CircuitPath

Property Details

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 geometry of the path, if the trace resultTypes includes geometry.

order Property order Number |null |undefined

The unique identifier for the path's order.

This is populated when multiple paths are returned for a path trace which uses connectivity inference.

pathConnectivity Property pathConnectivity CircuitPathConnectivityElement[]autocast

The edges and junctions that constitute the path.

pathId Property pathId Number |null |undefined

The unique identifier for the path.

startingPoint Property startingPoint TraceLocationautocast

The starting location for the path.

stoppingPoint Property stoppingPoint TraceLocationautocast

The stopping location for the path.

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
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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

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");