NetworkSystemLayers

AMD: require(["esri/networks/support/NetworkSystemLayers"], (NetworkSystemLayers) => { /* code goes here */ });
ESM: import NetworkSystemLayers from "@arcgis/core/networks/support/NetworkSystemLayers";
Class: esri/networks/support/NetworkSystemLayers
Inheritance: NetworkSystemLayers Accessor
Since: ArcGIS API for JavaScript 4.25

The NetworkSystemLayers contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers.

See also
Example
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.getItemAt(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

new NetworkSystemLayers(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Number

The layer ID of the service containing the utility network's dirty areas.

more details
NetworkSystemLayers
String

The service url containing the utility network's dirty areas.

more details
NetworkSystemLayers
Number

The layer ID of the service containing the network rules table.

more details
NetworkSystemLayers
String

The service url containing the network rules table.

more details
NetworkSystemLayers
Number

The layer ID of the service containing the utility network's Subnetworks table.

more details
NetworkSystemLayers
String

The service url containing the utility network's Subnetworks table.

more details
NetworkSystemLayers

Property Details

declaredClass Stringreadonly inherited

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

dirtyAreasLayerId Numberreadonly

The layer ID of the service containing the utility network's dirty areas.

dirtyAreasLayerUrl Stringreadonly

The service url containing the utility network's dirty areas.

rulesTableId Numberreadonly

The layer ID of the service containing the network rules table.

rulesTableUrl Stringreadonly

The service url containing the network rules table.

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 Stringreadonly

The service url containing the utility network's Subnetworks table.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited

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(groupKey)inherited

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.