ESM: import UtilityNetwork from "@arcgis/core/networks/UtilityNetwork.js";
CDN: const UtilityNetwork = await $arcgis.import("@arcgis/core/networks/UtilityNetwork.js");
Class: @arcgis/core/networks/UtilityNetwork
Since: ArcGIS Maps SDK for JavaScript 4.20
This class contains metadata about the utility network dataset retrieved from a WebMap. To access the full properties, users need to call webmap's load() method. Certain properties are available without calling load such as id and title. In 4.20, this object can only be retrieved from a webmap which has a utility network layer.
Examples
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();
}
});// Instantiating a UtilityNetwork instance using layerUrl
const utilityNetwork = new UtilityNetwork({layerUrl: "https://hostName.com/server/rest/services/Test/FeatureServer/17"});
await utilityNetwork.load(); new UtilityNetwork(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsThe full network definition, accessible only when the network is loaded.
The physical dataset name of the network as defined in the backend database. Accessible only when the network is loaded.
Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
domainNetworkNames String[]readonly
Returns all the domain networks in the utility network. Domain networks contain the network features through which your delivered resource flows.
Inherited
Property featureServiceUrl Stringreadonly
Returns the root feature service url which this network is part of.
Example
`https://utilitynetwork.esri.com/server/rest/services/NapervilleElectric/FeatureServer/`The full extent of the network, defined from the service territory used to create the network.
The version of the geodatabase of the feature service data. Read the Overview of versioning topic for more details about this capability.
The historic moment to query. If historicMoment is not specified, the query will apply to the current features.
Inherited
Property id String
Random unique id (UUID) to identify a network as defined in the webmap spec. Generated during sharing of the webmap.
Inherited
Property layerId Numberreadonly
The layer id of the network.
Inherited
Property layerUrl String
The full url to the network layer id as defined in the webmap spec. e.g. https://utilitynetwork.esri.com/server/rest/services/NapervilleElectric/FeatureServer/17 (where 17 is the layer id of the network)
The Error object returned if an error occurred while loading.
Inherited
Property loadStatus Stringreadonly
Represents the status of a load operation.
Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details.Possible Values:"not-loaded" |"loading" |"failed" |"loaded"
Default Value:"not-loaded"
Inherited
Property loadWarnings Object[]readonly
A list of warnings which occurred while loading.
Inherited
Property loaded Booleanreadonly
Indicates whether the network instance has loaded. When true, all the properties of the object can be accessed.
Inherited
Property networkServiceUrl Stringreadonly
Returns the url of network server.
Example
`https://utilitynetwork.esri.com/server/rest/services/NapervilleElectric/UtilityNetworkServer/`Contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers.
Example
// Print out the dirty areas layer url in the utility network
view.when(async () => {
// Check if the webmap contains utility networks
if(webmap?.utilityNetworks?.length > 0) {
// Assigns the utility network at index 0
utilityNetwork = webmap.utilityNetworks.at(0);
// Load the utility network
await utilityNetwork.load();
// Print the dirty areas layer url and id
console.log(`Dirty areas layer id: ${utilityNetwork.networkSystemLayers.dirtyAreasLayerId}`);
console.log(`Dirty areas layer url: ${utilityNetwork.networkSystemLayers.dirtyAreasLayerUrl}`);
}
});The portal user owner of the network. This portal user can perform administrative actions against the network.
Inherited
Property parsedUrl Objectreadonly
Converts url to a url object
The schema version of the network. Each version of the network introduces new features and capabilities. e.g. A utility network created with ArcGIS Pro 2.8 will have a schema generation version 5. While a UN created with ArcGIS Pro 2.6 will be version 4.
serviceTerritoryFeatureLayerId Number |null |undefinedreadonly
The layer id of the service territory class used to define the extent of the utility network. Value is null when a service territory layer is not published to the feature service.
This property returns the list of trace configurations shared on the webmap. It is empty when no trace configurations are shared on the webmap. This property can be used without fully loading the utility network, but only the globalId and the title will be available.
Inherited
Property sourceJSON Object
The spatial reference of the network, defined at the creation of the network, usually from the service territory class.
Returns all the terminal configurations on the utility network. Terminal configurations defines how many terminals a device has and how those terminals are setup. Must load the utility network to access this.
Inherited
Property title String
The name of the network as defined in the webmap spec. Represents the layer name of the network layer defined while sharing the webmap.
type Stringreadonly
The type of the dataset. Returns utility if the object represents a utility network.
For UtilityNetwork the type is always "utility".
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.
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();
Parameters
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.
canAddAssociation(association){Promise<Boolean>}
Since: ArcGIS Maps SDK for JavaScript 4.29 UtilityNetwork since 4.29, canAddAssociation added at 4.29.
Returns true if the given Association is valid.
Parameter
Association that needs to be validated.
Returns
Example
const association = new Association({
globalId: "{88355CB3-B011-4715-BB90-047B8C7ABF48}",
fromNetworkElement: new NetworkElement({
globalId: "{09B7A0F9-811D-4CCF-95A9-D1995D44C631}",
networkSourceId: 8,
terminalId: 1,
assetGroupCode: 1,
assetTypeCode: 1,
}),
toNetworkElement: new NetworkElement({
globalId: "{86DD4700-4D1B-4872-93CD-68783F7996B6}",
networkSourceId: 10,
terminalId: 1,
assetGroupCode: 2,
assetTypeCode: 2,
}),
associationType: "attachment",
});
const isValidAssociation = await utilityNetwork.canAddAssociation(association);Inherited
Method cancelLoad()
Cancels a load() operation if it is already in progress.
Inherited
Method fromJSON(json){* |null |undefined}static
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.
Returns
Type Description * | null | undefined Returns a new instance of this class. generateAddAssociations(association){ServiceEdits}
Since: ArcGIS Maps SDK for JavaScript 4.29 UtilityNetwork since 4.29, generateAddAssociations added at 4.29.
Returns ServiceEdits which are used to add an Association via the applyEdits method on the FeatureService class.
Note: it is advisable to load the associations layer before calling this method, which can be done by calling the loadAssociationsTable method. Loading the associations table ensures that the attributes of the resulting associations use the correctly-cased field names. If the associations table is not loaded, the field names will be in lowercase.
Returns
Example
const association = new Association({
globalId: "{88355CB3-B011-4715-BB90-047B8C7ABF48}",
fromNetworkElement: new NetworkElement({
globalId: "{09B7A0F9-811D-4CCF-95A9-D1995D44C631}",
networkSourceId: 8,
terminalId: 1,
assetGroupCode: 1,
assetTypeCode: 1,
}),
toNetworkElement: new NetworkElement({
globalId: "{86DD4700-4D1B-4872-93CD-68783F7996B6}",
networkSourceId: 10,
terminalId: 1,
assetGroupCode: 2,
assetTypeCode: 2,
}),
associationType: "attachment",
});
const isValidAssociation = await utilityNetwork.canAddAssociation(association);
const generatedAssociations = utilityNetwork.generateAddAssociation([association]);
const featureService = new FeatureService({ url: "https://hostName.com/server/rest/services/Test/FeatureServer" });
featureService.applyEdits([generatedAssociations],
{
gdbVersion: "unadmin.testVersion",
globalIdUsed: false,
honorSequenceOfEdits: false
usePreviousEditMoment: false,
returnServiceEditsInSourceSR: true,
}) generateDeleteAssociations(association){ServiceEdits}
Since: ArcGIS Maps SDK for JavaScript 4.29 UtilityNetwork since 4.29, generateDeleteAssociations added at 4.29.
Returns ServiceEdits which are used to delete an Association via the applyEdits method on the FeatureService class.
Returns
Example
const association = new Association({
globalId: "{323FF251-A5FC-4665-97A3-D78615C3DD21}",
});
const generatedDeleteAssociations = utilityNetwork.generateDeleteAssociations([association]);
const featureService = new FeatureService({ url: "https://hostName.com/server/rest/services/Test/FeatureServer" });
featureService.applyEdits([generatedDeleteAssociations],
{
gdbVersion: "unadmin.testVersion",
globalIdUsed: true, //globalIdUsed must be true when deleting associations with this workflow
honorSequenceOfEdits: false
usePreviousEditMoment: false,
returnServiceEditsInSourceSR: true,
})The network consists of sources (classes) and each source has a unique Id. These source Ids are used to perform traversal in the network topology. The trace end points are not aware of layers and only returns sources of results. This method returns the layerId for given a source Id. Used as a helper method to process trace results.
Returns
Inherited
Method getObjectIdsFromElements(elements){LayerInfo[]}
Groups network elements by their layerId. Returns a list containing the objectIds within each layer.
Returns
Type Description LayerInfo[] Array of objects containing layerId and objectIds.All devices features have terminal configurations (default single terminal). Users can use this method to retrieve the assigned terminal configuration of a given feature. This method takes a graphic/feature, uses the ASSETGROUP and ASSETTYPE fields along side the network source to find out the assigned terminal configuration. If either ASSETGROUP, ASSETTYPE or layer are not populated a null is returned. Returns null if terminal configuration object couldn't be found.
Parameter
The graphic feature to get the terminal configuration from. Must belong to a device layer, and have ASSETGROUP and ASSETTYPE fields populated.
Returns
Type Description TerminalConfiguration | null | undefined The terminal configuration object. Most devices have a single terminal configuration unless configured otherwise. getTierNames(domainNetworkName){String[]}
Takes the name of a domain network and returns an array with the names of its tiers. A domain network can have one or several tiers. A tier is a subgrouping of a domain network that represents the logical hierarchy of subnetworks.
Parameter
The name of the domain network.
Returns
Type Description String[] Returns an array of tier names.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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
Method isFulfilled(){Boolean}
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method isRejected(){Boolean}
isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method isResolved(){Boolean}
isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been resolved. isUtilityLayer(layer){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.32 UtilityNetwork since 4.29, isUtilityLayer added at 4.32.
Returns a boolean indicating if the layer is a utility layer belonging to the network.
Returns
Type Description Boolean value indicating membership of the layer in the utility network. load(){Promise}
Triggers the loading of the UtilityNetwork instance.
Fully loads the utility network definition and all the shared named trace configurations.
Returns
Type Description Promise Resolves when the UtilityNetwork is loaded. loadAssociationsTable(){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.32 UtilityNetwork since 4.29, loadAssociationsTable added at 4.32.
Loads the Utility Network's associations table.
Returns
Type Description Promise Resolves with a loaded instance of FeatureLayer representing the associations table. queryAssociations(props){Promise<Association[]>}
Since: ArcGIS Maps SDK for JavaScript 4.28 UtilityNetwork since 4.29, queryAssociations added at 4.28.
Returns all associations filtered by the QueryAssociationsParameters in a utility network. The gdbVersion and moment properties of the props parameter will be hydrated from this UtilityNetwork.
Returns
Type Description Promise<Association[]> When resolved, the list of returned Associations from the query.Inherited
Method queryNamedTraceConfigurations(query, options){Promise<NamedTraceConfiguration[]>}
Since: ArcGIS Maps SDK for JavaScript 4.25 Network since 4.31, queryNamedTraceConfigurations added at 4.25.
Named trace configurations allow you to add and store complex traces in a network that can be shared across an organization through web maps and consumed by web and field applications. This method returns a list of NamedTraceConfiguration objects that meet specific search conditions. Used to find existing named trace configurations in a utility network.
Parameters
optionalThe query parameters that are used to determine which named trace configurations will be returned.
Specification
optionalAn array of the named trace configuration creators to be queried.
optionalAn array of named trace configuration globalIds (UUID) to be queried.
optionalAn array of named trace configuration names to be queried.
optionalAn array of named trace configuration user tags to be queried.
optionalThe request options specified by the user in the data request. See RequestOptions for available properties.
Returns
Type Description Promise<NamedTraceConfiguration[]> Resolves with an array of named trace configurations filtered based on the query parameters.Examples
// Initialize the query object with global IDs of the named trace configurations to query.
const query = {
globalIds: ["5dbb5a13-ab2f-452d-bfcb-6f98154ccb9d", "cf568e46-f200-486c-adb1-d008a3da0ed1"],
}
// Query the utility network named trace configurations
// and filter the results by the query object.
const namedTraceConfigurations = await utilityNetwork.queryNamedTraceConfigurations(query);
// Print the named trace configurations to the console.
console.log(namedTraceConfigurations)// Calling this method without parameters returns all named trace configurations in the utility network.
const namedTraceConfigurations = await utilityNetwork.queryNamedTraceConfigurations({});
// Print all the named trace configurations to the console.
console.log(namedTraceConfigurations);Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");Since: ArcGIS Maps SDK for JavaScript 4.26 UtilityNetwork since 4.29, submitTopologyValidationJob added at 4.26.
Whenever the network is edited or modified, the network and its features become out of date in the network topology. Validating the network topology maintains consistency and up-to-date content between the feature editing space and network topology space. Validating a network topology may include all or a subset of the dirty areas layer present in the network.
Returns
Example
const extent = new Extent({
xmin: 470789.0888,
ymin: 3597733.2051,
xmax: 531454.2759999996,
ymax: 3639864.802100001,
spatialReference: { wkid: 26911, latestWkid: 26911 }
});
const validationResult = await network.submitTopologyValidationJob({
validateArea: extent,
gdbVersion: "sde.DEFAULT",
validationType: "rebuild",
validationSet: [
{
sourceId: 4134325151,
globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"]
}
]
}); submitTraceJob(props){Promise<TraceJobInfo>}
Since: ArcGIS Maps SDK for JavaScript 4.27 UtilityNetwork since 4.29, submitTraceJob added at 4.27.
The submitTraceJob method takes a set of parameters, executes the asynchronous trace on the backend, and returns trace results.
Parameters
Specification
Props consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType.
Specification
namedTraceConfigurationGlobalId String optionalThe globalId (UUID) of the named trace configuration persisted in the network.
optionalThe list of starting points and barriers that will define where the trace starts and stops. This parameter can be optional (defaults to empty array) if minStartingPoints in NamedTraceConfiguration is set to none.
The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).
optionalDefines the properties of a trace.
optionalParameter specifying the types of results to return after running a trace.
optionalThe traceType defined in this trace configuration.
Possible Values:"connected"|"upstream"|"downstream"|"shortest-path"|"subnetwork"|"subnetwork-controller"|"loops"|"isolation"
Returns
Type Description Promise<TraceJobInfo> Returns a Promise of TraceJobInfo.Since: ArcGIS Maps SDK for JavaScript 4.28 UtilityNetwork since 4.29, synthesizeAssociationGeometries added at 4.28.
Given an extent, returns all associations within this extent and their synthesized geometries. The gdbVersion and moment properties of the props parameter will be hydrated from this UtilityNetwork.
Parameter
Describes the parameters required to execute the synthesizeAssociationGeometries method which synthesizes and returns the associations geometries in a given extent.
Returns
Since: ArcGIS Maps SDK for JavaScript 4.27 UtilityNetwork since 4.29, trace added at 4.27.
The trace method takes a set of parameters, executes the trace on the backend, and returns trace results.
Parameters
Specification
Props consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType.
Specification
namedTraceConfigurationGlobalId String optionalThe globalId (UUID) of the named trace configuration persisted in the network.
optionalThe list of starting points and barriers that will define where the trace starts and stops. This parameter can be optional (defaults to empty array) if minStartingPoints in NamedTraceConfiguration is set to none.
The spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).
optionalDefines the properties of a trace.
optionalParameter specifying the types of results to return after running a trace.
optionalThe traceType defined in this trace configuration.
Possible Values:"connected"|"upstream"|"downstream"|"shortest-path"|"subnetwork"|"subnetwork-controller"|"loops"|"isolation"
Returns
Type Description Promise<TraceResult> Returns a Promise of TraceResult.Since: ArcGIS Maps SDK for JavaScript 4.26 UtilityNetwork since 4.29, validateTopology added at 4.26.
Whenever the network is edited or modified, the network and its features become out of date in the network topology. Validating the network topology maintains consistency and up-to-date content between the feature editing space and network topology space. Validating a network topology may include all or a subset of the dirty areas present in the network.
Returns
Example
const extent = new Extent({
xmin: 470789.0888,
ymin: 3597733.2051,
xmax: 531454.2759999996,
ymax: 3639864.802100001,
spatialReference: { wkid: 26911, latestWkid: 26911 }
});
const result = await network.validateTopology({
validateArea: extent
});Inherited
Method when(callback, errback){Promise}
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback that may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
// This function will execute once the promise is resolved
}, function(error){
// This function will execute if the promise is rejected due to an error
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4