require(["esri/networks/support/NetworkSystemLayers"], (NetworkSystemLayers) => { /* code goes here */ });
import NetworkSystemLayers from "@arcgis/core/networks/support/NetworkSystemLayers.js";
esri/networks/support/NetworkSystemLayers
The NetworkSystemLayers contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers.
- See also
require([
"esri/WebMap",
"esri/views/MapView",
"esri/config"
], (WebMap, MapView, esriConfig) => {
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 |
---|---|---|---|
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 | ||
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
-
associationsTableId
associationsTableId Numberreadonly
Since: ArcGIS Maps SDK for JavaScript 4.29NetworkSystemLayers since 4.25, associationsTableId added at 4.29. -
-
associationsTableUrl
associationsTableUrl Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.29NetworkSystemLayers since 4.25, associationsTableUrl added at 4.29. -
-
dirtyAreasLayerId
dirtyAreasLayerId Numberreadonly
-
The layer ID of the service containing the utility network's dirty areas.
-
dirtyAreasLayerUrl
dirtyAreasLayerUrl Stringreadonly
-
The service url containing the utility network's dirty areas.
-
rulesTableId
rulesTableId Numberreadonly
-
The layer ID of the service containing the network rules table.
-
rulesTableUrl
rulesTableUrl Stringreadonly
-
The service url containing the network rules table.
-
subnetworksTableId
subnetworksTableId Numberreadonly
-
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.
-
subnetworksTableUrl
subnetworksTableUrl Stringreadonly
-
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 | ||
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 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"); }
-
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");