import NetworkSystemLayers from "@arcgis/core/networks/support/NetworkSystemLayers.js";
const NetworkSystemLayers = await $arcgis.import("@arcgis/core/networks/support/NetworkSystemLayers.js");
@arcgis/core/networks/support/NetworkSystemLayers
The NetworkSystemLayers contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers.
- See also
const [WebMap, MapView, esriConfig] = await $arcgis.import([
"@arcgis/core/WebMap.js",
"@arcgis/core/views/MapView.js",
"@arcgis/core/config.js"
]);
let utilityNetwork;
// set the hostname to the portal instance
esriConfig.portalUrl = "https://myHostName.domain.com/arcgis";
const webMap = new WebMap({
portalItem: {
id: "webmapID"
}
});
const mapView = new MapView({
map: webMap
});
webMap.when(async () => {
// check if webMap contains utility networks
if (webMap.utilityNetworks.length > 0) {
// assign the utility network at index 0
utilityNetwork = webMap.utilityNetworks.at(0);
// trigger the loading of the UtilityNetwork instance
await utilityNetwork.load();
// Print the subnetworks table service url and id
console.log(`Dirty areas layer id: ${utilityNetwork.networkSystemLayers.subnetworksTableId}`);
console.log(`Dirty areas layer url: ${utilityNetwork.networkSystemLayers.subnetworksTableUrl}`);
}
});
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 |
|---|---|---|---|
A FeatureLayer representing the associations table. | NetworkSystemLayers | ||
| NetworkSystemLayers | |||
| NetworkSystemLayers | |||
The name of the class. | Accessor | ||
The layer ID of the service containing the utility network's dirty areas. | NetworkSystemLayers | ||
The service url containing the utility network's dirty areas. | NetworkSystemLayers | ||
The layer ID of the service containing the network rules table. | NetworkSystemLayers | ||
The service url containing the network rules table. | NetworkSystemLayers | ||
A FeatureLayer representing the subnetworks table. | NetworkSystemLayers | ||
The layer ID of the service containing the utility network's Subnetworks table. | NetworkSystemLayers | ||
The service url containing the utility network's Subnetworks table. | NetworkSystemLayers |
Property Details
-
associationsTable
PropertyassociationsTable FeatureLayer |null |undefinedreadonlySince: ArcGIS Maps SDK for JavaScript 4.32NetworkSystemLayers since 4.25, associationsTable added at 4.32. -
A FeatureLayer representing the associations table. This layer is only loaded as needed, so the property has a default value of
null. It can be set by calling the loadAssocationsTable method.
-
Since: ArcGIS Maps SDK for JavaScript 4.29NetworkSystemLayers since 4.25, associationsTableId added at 4.29. -
-
Since: ArcGIS Maps SDK for JavaScript 4.29NetworkSystemLayers since 4.25, associationsTableUrl added at 4.29. -
-
The layer ID of the service containing the utility network's dirty areas.
-
The service url containing the utility network's dirty areas.
-
The layer ID of the service containing the network rules table.
-
The service url containing the network rules table.
-
subnetworksTable
PropertysubnetworksTable FeatureLayer |null |undefinedreadonlySince: ArcGIS Maps SDK for JavaScript 4.34NetworkSystemLayers since 4.25, subnetworksTable added at 4.34. -
A FeatureLayer representing the subnetworks table. This layer is only loaded as needed, so the property has a default value of
null. It can be set by calling the loadSubnetworksTable method.
-
The layer ID of the service containing the utility network's Subnetworks table. The Subnetworks table contains the information about all the existing and deleted subnetworks in a utility network.
-
The service url containing the utility network's Subnetworks table.
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 true if a named group of handles exist. | Accessor | ||
Promise<FeatureLayer> | Loads the layer identified by the | NetworkSystemLayers | |
Promise<FeatureLayer> | Loads the layer identified by the | NetworkSystemLayers | |
Removes a group of handles owned by the object. | Accessor |
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.
-
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"); }
-
loadAssociationsTable
MethodloadAssociationsTable(options){Promise<FeatureLayer>}Since: ArcGIS Maps SDK for JavaScript 4.32NetworkSystemLayers since 4.25, loadAssociationsTable added at 4.32. -
Loads the layer identified by the
associationsTableUrlproperty.Parametersoptions AbortOptionsoptionalAn object containing an optional
signalproperty that can be used to cancel the request.Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<FeatureLayer> Resolves to a loaded instance of FeatureLayer representing the associations table.
-
loadSubnetworksTable
MethodloadSubnetworksTable(options){Promise<FeatureLayer>}Since: ArcGIS Maps SDK for JavaScript 4.34NetworkSystemLayers since 4.25, loadSubnetworksTable added at 4.34. -
Loads the layer identified by the
subnetworksTableUrlproperty.Parametersoptions AbortOptionsoptionalAn object containing an optional
signalproperty that can be used to cancel the request.Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<FeatureLayer> Resolves to a loaded instance of FeatureLayer representing the subnetworks table.
-
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");