Subcircuit | API Reference | ArcGIS Maps SDK for JavaScript

Represents a subcircuit in a telecom domain network.

See also

Constructors

Subcircuit Constructor new Subcircuit(properties)

Parameter

properties Object

optional

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

Property Overview

Type	Summary	Class
HashMap<any>\|null\|undefined	User-defined attributes on the subcircuit.	Subcircuit
String\|null\|undefined	The global ID of the circuit that consumes the subcircuit.	Subcircuit
String\|null\|undefined	The global ID of the subcircuit.	Subcircuit
Boolean	Whether the subcircuit is reserved for use by its own circuit.	Subcircuit
String	The name of the subcircuit.	Subcircuit
String\|null\|undefined	The global ID of the provider circuit in which the subcircuit participates.	Subcircuit

Property Details

attributes Property attributes HashMap<any> |null |undefined

User-defined attributes on the subcircuit.

consumerId Property consumerId String |null |undefined

The global ID of the circuit that consumes the subcircuit.

globalId Property globalId String |null |undefined

The global ID of the subcircuit.

isReserved Property isReserved Boolean

Whether the subcircuit is reserved for use by its own circuit.

When a subcircuit is reserved, it is assigned to its provider circuit and is not available for consumption by other circuits. A subcircuit is reserved when provider ID and consumer ID are the same.

name Property name String

The name of the subcircuit. This name is unique within a circuit.

providerId Property providerId String |null |undefined

The global ID of the provider circuit in which the subcircuit participates.

Method Overview

Name	Return Type	Summary	Class
	*	Returns the value of the specified attribute.	Subcircuit
	void	Sets a new value for the specified attribute.	Subcircuit

Method Details

getAttribute Method getAttribute(name){*}

Returns the value of the specified attribute.

Parameter

name String

The name of the attribute.

Returns

Type	Description
*	Returns the value of the attribute specified by `name`.

setAttribute Method setAttribute(name, newValue){void}

Sets a new value for the specified attribute.

Parameters

name String

The name of the attribute to set.

newValue *

The new value to set on the named attribute.

Returns

Type	Description
void