import Subcircuit from "@arcgis/core/networks/support/Subcircuit.js";
const Subcircuit = await $arcgis.import("@arcgis/core/networks/support/Subcircuit.js");
@arcgis/core/networks/support/Subcircuit
Represents a subcircuit in a telecom domain network.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
User-defined attributes on the subcircuit. | Subcircuit | ||
The global ID of the circuit that consumes the subcircuit. | Subcircuit | ||
The name of the class. | Accessor | ||
The global ID of the subcircuit. | Subcircuit | ||
Whether the subcircuit is reserved for use by its own circuit. | Subcircuit | ||
The name of the subcircuit. | Subcircuit | ||
The global ID of the provider circuit in which the subcircuit participates. | Subcircuit |
Property Details
-
User-defined attributes on the subcircuit.
-
The global ID of the circuit that consumes the subcircuit.
-
isReserved
PropertyisReserved 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
Propertyname String -
The name of the subcircuit. This name is unique within a circuit.
-
The global ID of the provider circuit in which the subcircuit participates.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Returns the value of the specified attribute. | Subcircuit | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
void | Sets a new value for the specified attribute. | Subcircuit |
Method Details
-
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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Returns the value of the specified attribute.
Parametername StringThe name of the attribute.
ReturnsType Description * Returns the value of the attribute specified by name.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Sets a new value for the specified attribute.
Parametersname StringThe name of the attribute to set.
newValue *The new value to set on the named attribute.
ReturnsType Description void