NetworkElement | References | ArcGIS Maps SDK for JavaScript

import NetworkElement from "@arcgis/core/rest/networks/support/NetworkElement.js";

Inheritance:: NetworkElement→Accessor

Subclasses:: TelecomNetworkElement

Since: ArcGIS Maps SDK 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

trace

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`NetworkElementProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`assetGroupCode`	`number`
`assetTypeCode`	`number`
`declaredClass` readonly inherited	`string`	Accessor
`globalId`	`string`
`networkSourceId`	`number`
`objectId`	`number`
`positionFrom`	`number`
`positionTo`	`number \| null \| undefined`
`terminalId`	`number \| null \| undefined`
`type` readonly	`"networkElement" \| "telecomNetworkElement"`

assetGroupCode

Property

Type: number

The asset group code that this network element represents.

assetTypeCode

Property

Type: number

The asset type code discriminator this network element represents.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

globalId

Property

Type: string

The globalId of the feature the network element belongs to.

networkSourceId

Property

Type: number

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

objectId

Property

Type: number

The objectId of the feature the network element belongs to.

positionFrom

Property

Type: 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

Property

Type: number | null | undefined

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

Property

Type: number | null | undefined

The terminal id defined at the network element. The telecom domain network does not use terminals, so TelecomNetworkElement always has a null terminalId.

See also

Terminal

type

readonly Property

Type: "networkElement" | "telecomNetworkElement"

The type of the network element. This is always networkElement unless the object is a TelecomNetworkElement in a telecom domain network.

Type telecomNetworkElement is reserved for telecom domain networks.

Default value: "networkElement"

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.