TelecomNetworkElement | API Reference | ArcGIS Maps SDK for JavaScript

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

Constructors

TelecomNetworkElement Constructor new TelecomNetworkElement(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Number	The asset group code that this network element represents.	NetworkElement
Number	The asset type code discriminator this network element represents.	NetworkElement
String	The name of the class.	Accessor
Number\|null\|undefined	The unit offset in a grouped object in a telecom domain network.	TelecomNetworkElement
String	The globalId of the feature the network element belongs to.	NetworkElement
Number	The network source Id of the feature the network element belongs to.	NetworkElement
Number\|null\|undefined	The number of logically grouped objects the element represents in a telecom domain network.	TelecomNetworkElement
Number	The objectId of the feature the network element belongs to.	NetworkElement
Number	Applicable to edge elements, represents a double value (0 to 1) where this edge element starts.	NetworkElement
Number\|null\|undefined	Applicable to edge elements, represents a double value (0 to 1) where this edge element ends.	NetworkElement
Number	The terminal id defined at the network element.	NetworkElement
String	The type of the network element.	TelecomNetworkElement

Property Details

assetGroupCode Inherited Property assetGroupCode Number Inherited from NetworkElement

The asset group code that this network element represents.

assetTypeCode Inherited Property assetTypeCode Number Inherited from NetworkElement

The asset type code discriminator this network element represents.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

firstUnit Property firstUnit Number |null |undefined

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

globalId Inherited Property globalId String Inherited from NetworkElement

The globalId of the feature the network element belongs to.

networkSourceId Inherited Property networkSourceId Number Inherited from NetworkElement

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.

numUnits Property numUnits Number |null |undefined

The number of logically grouped objects the element represents in a telecom domain network.

objectId Inherited Property objectId Number Inherited from NetworkElement

The objectId of the feature the network element belongs to.

positionFrom Inherited Property positionFrom 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 positionTo 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 terminalId Number Inherited from NetworkElement

The terminal id defined at the network element.

See also

Terminal

type Property type Stringreadonly

The type of the network element.

Possible Values:"networkElement" |"telecomNetworkElement"

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
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	NetworkElement
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	NetworkElement

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.

fromJSON Inherited Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

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

toJSON Inherited Method toJSON(){Object} Inherited from NetworkElement

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.