Skip to content
import TelecomNetworkElement from "@arcgis/core/rest/networks/support/TelecomNetworkElement.js";
Inheritance:
TelecomNetworkElementNetworkElementAccessor
Since
ArcGIS Maps SDK for JavaScript 4.34
beta

TelecomNetworkElement inherits from NetworkElement and adds two new properties: firstUnit and lastUnit. This class is used to represent network elements in a telecom domain network.

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
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.

assetGroupCode

inherited Property
Type
number
Inherited from: NetworkElement

The asset group code that this network element represents.

assetTypeCode

inherited Property
Type
number
Inherited from: NetworkElement

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.

firstUnit

Property
Type
number | null

The first unit in a grouped object in a telecom domain network.

globalId

inherited Property
Type
string
Inherited from: NetworkElement

The globalId of the feature the network element belongs to.

lastUnit

Property
Type
number | null

The last unit in a grouped object in a telecom domain network.

networkSourceId

inherited Property
Type
number
Inherited from: NetworkElement

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

inherited Property
Type
number
Inherited from: NetworkElement

The objectId of the feature the network element belongs to.

positionFrom

inherited Property
Type
number
Inherited from: NetworkElement

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

inherited Property
Type
number | null | undefined
Inherited from: NetworkElement

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

inherited Property
Type
number | null | undefined
Inherited from: NetworkElement

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

type

readonly Property
Type
"networkElement" | "telecomNetworkElement"

The type of the network element.

Default value
"telecomNetworkElement"

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
toJSON
inherited
toJSON(): any

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
ParameterTypeDescriptionRequired
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.