NetworkElement

AMD: require(["esri/rest/networks/support/NetworkElement"], (NetworkElement) => { /* code goes here */ });
ESM: import NetworkElement from "@arcgis/core/rest/networks/support/NetworkElement";
Class: esri/rest/networks/support/NetworkElement
Inheritance: NetworkElement Accessor
Since: ArcGIS API for JavaScript 4.20

The network element is a representation of how the network topology defines its graph. The network topology (or index) work with network elements and thats how the trace traverses those elements. This class contains basic properties as seen in the network topology. For performance reasons, many utility network functions return network elements and not "full" features. One feature can have many network elements.

An example is a tri-state transformer with 3 terminals with High side (H) and two Low sides (X1, X2). The feature globalId could be g but it is composed of three network elements, g-H, g-X1 and g-X2.

     H

   /   \

X1       X2

It is worth mentioning that elements in the network topology also have an elementId which is purely internal to the network and not exposed externally. Those elementIds are then converted to matching objectId/globalId`.

See also

Constructors

new NetworkElement(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Number

The asset group code that this network element represents.

more details
NetworkElement
Number

The asset type code discriminator this network element represents.

more details
NetworkElement
String

The name of the class.

more details
Accessor
String

The globalId of the feature the network element belongs to.

more details
NetworkElement
Number

The network source Id of the feature the network element belongs to.

more details
NetworkElement
Number

The objectId of the feature the network element belongs to.

more details
NetworkElement
Number

Applicable to edge elements, represents a double value (0 to 1) where this edge element starts.

more details
NetworkElement
Number

Applicable to edge elements, represents a double value (0 to 1) where this edge element ends.

more details
NetworkElement
Number

The terminal id defined at the network element.

more details
NetworkElement

Property Details

assetGroupCode Number

The asset group code that this network element represents.

assetTypeCode Number

The asset type code discriminator this network element represents.

declaredClass Stringreadonly inherited

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

globalId String

The globalId of the feature the network element belongs to.

networkSourceId Number

The network source Id of the feature the network element belongs to. Note that this is different from layerId and you need to use getLayerIdBySourceId() to get the layerId.

objectId Number

The objectId of the feature the network element belongs to.

positionFrom Number

Applicable to edge elements, represents a double value (0 to 1) where this edge element starts.

Example
Line feature with objectId 100 with 2 midspan junctions (j1,j2). The line feature has 3 edge network elements
F-j1, j1-j2 and j2-T.

                                       OID=100
                               F------j1------j2------T

F-j1  (objectId=100, positionFrom=0, positionTo=0.33)
j1-j2 (objectId=100, positionFrom=0.33, positionTo=0.66)
j2-T  (objectId=100, positionFrom=0.66, positionTo=1)
positionTo Number

Applicable to edge elements, represents a double value (0 to 1) where this edge element ends.

Example
Line feature with objectId 100 with 2 midspan junctions (j1,j2). The line feature has 3 edge network elements
F-j1, j1-j2 and j2-T.

                                       OID=100
                               F------j1------j2------T

F-j1  (objectId=100, positionFrom=0, positionTo=0.33)
j1-j2 (objectId=100, positionFrom=0.33, positionTo=0.66)
j2-T  (objectId=100, positionFrom=0.66, positionTo=1)
terminalId Number

The terminal id defined at the network element.

See also

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
NetworkElement
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
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
NetworkElement

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.