require(["esri/networks/UtilityNetwork"], (UtilityNetwork) => { /* code goes here */ });
import UtilityNetwork from "@arcgis/core/networks/UtilityNetwork.js";
esri/networks/UtilityNetwork
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.
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();
}
});
});
// Instantiating a UtilityNetwork instance using layerUrl
const utilityNetwork = new UtilityNetwork({layerUrl: "https://hostName.com/server/rest/services/Test/FeatureServer/17"});
await utilityNetwork.load();
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 |
---|---|---|---|
The full network definition, accessible only when the network is loaded. | Network | ||
The physical dataset name of the network as defined in the backend database. | Network | ||
The name of the class. | Accessor | ||
Returns all the domain networks in the utility network. | UtilityNetwork | ||
Returns the root feature service url which this network is part of. | Network | ||
The full extent of the network, defined from the service territory used to create the network. | Network | ||
Random unique id (UUID) to identify a network as defined in the webmap spec. | Network | ||
The layer id of the network. | Network | ||
The full url to the network layer id as defined in the webmap spec. | Network | ||
Indicates whether the network instance has loaded. | Network | ||
The Error object returned if an error occurred while loading. | Network | ||
Represents the status of a load operation. | Network | ||
A list of warnings which occurred while loading. | Network | ||
Returns the url of network server. | Network | ||
Contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. | UtilityNetwork | ||
The portal user owner of the network. | Network | ||
Converts url to a url object | Network | ||
The schema version of the network. | Network | ||
The layer id of the service territory class used to define the extent of the utility network. | UtilityNetwork | ||
This property returns the list of trace configurations shared on the webmap. | UtilityNetwork | ||
Network | |||
The spatial reference of the network, defined at the creation of the network, usually from the service territory class. | Network | ||
Returns all the terminal configurations on the utility network. | UtilityNetwork | ||
The name of the network as defined in the webmap spec. | Network | ||
The type of the dataset. | UtilityNetwork |
Property Details
-
Returns all the domain networks in the utility network. Domain networks contain the network features through which your delivered resource flows.
- See also
-
loadStatus
InheritedPropertyloadStatus Stringreadonly
Inherited from Network -
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 from Network
-
A list of warnings which occurred while loading.
-
networkSystemLayers
networkSystemLayers NetworkSystemLayersreadonly
-
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}`); } });
-
schemaGeneration
InheritedPropertyschemaGeneration Numberreadonly
Inherited from Network -
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
serviceTerritoryFeatureLayerId Numberreadonly
-
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.
-
sharedNamedTraceConfigurations
sharedNamedTraceConfigurations NamedTraceConfiguration[]
-
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 thetitle
will be available.
-
spatialReference
InheritedPropertyspatialReference SpatialReference
Inherited from Network -
The spatial reference of the network, defined at the creation of the network, usually from the service territory class.
-
terminalConfigurations
terminalConfigurations TerminalConfiguration[]readonly
-
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.
- See also
-
type
type Stringreadonly
-
The type of the dataset. Returns
utility
if the object represents a utility network.For UtilityNetwork the type is always "utility".
- Default Value:"utility"
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 | UtilityNetwork | ||
Cancels a load() operation if it is already in progress. | Network | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Network | |
Returns ServiceEdits which are used to add an Association via the | UtilityNetwork | ||
Returns ServiceEdits which are used to delete an Association via the | UtilityNetwork | ||
The network consists of sources (classes) and each source has a unique Id. | Network | ||
All devices features have terminal configurations (default single terminal). | UtilityNetwork | ||
Takes the name of a domain network and returns an array with the names of its tiers. | UtilityNetwork | ||
Returns true if a named group of handles exist. | Accessor | ||
| Network | ||
| Network | ||
| Network | ||
Triggers the loading of the UtilityNetwork instance. | UtilityNetwork | ||
Returns all associations filtered by the QueryAssociationsParameters in a utility network. | UtilityNetwork | ||
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. | Network | ||
Removes a group of handles owned by the object. | Accessor | ||
Whenever the network is edited or modified, the network and its features become out of date in the network topology. | UtilityNetwork | ||
Takes the traceProps and preforms an async trace on a UtilityNetwork. | UtilityNetwork | ||
Given an extent, returns all associations within this extent and their synthesized geometries. | UtilityNetwork | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | Network | ||
Takes the traceProps and preforms a trace on a UtilityNetwork. | UtilityNetwork | ||
Whenever the network is edited or modified, the network and its features become out of date in the network topology. | UtilityNetwork | ||
| Network |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
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.
-
Since: ArcGIS Maps SDK for JavaScript 4.29UtilityNetwork since 4.29, canAddAssociation added at 4.29. -
Returns
true
if the given Association is valid.Parameterassociation AssociationAssociation that needs to be validated.
ReturnsType Description Promise<boolean> - Returns true if given Association is valid.
Exampleconst 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);
-
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.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
generateAddAssociations
generateAddAssociations(association){ServiceEdits}
Since: ArcGIS Maps SDK for JavaScript 4.29UtilityNetwork 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.Parameterassociation Association[]Association
used to generate the ServiceEdits object.ReturnsType Description ServiceEdits Returns ServiceEdits
which are used to add an Association via theapplyEdits
method on the FeatureService class.Exampleconst 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
generateDeleteAssociations(association){ServiceEdits}
Since: ArcGIS Maps SDK for JavaScript 4.29UtilityNetwork 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.Parameterassociation Association[]Association
used to generate the ServiceEdits object.ReturnsType Description ServiceEdits Returns ServiceEdits
which are used to delete an Association via theapplyEdits
method on the FeatureService class.Exampleconst 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([association], { gdbVersion: "unadmin.testVersion", globalIdUsed: true, //globalIdUsed must be true when deleting associations with this workflow honorSequenceOfEdits: false usePreviousEditMoment: false, returnServiceEditsInSourceSR: true, })
-
getLayerIdBySourceId
InheritedMethodgetLayerIdBySourceId(id){Number}
Inherited from Network -
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.
Parameterid NumberThe id of the source.
ReturnsType Description Number The layer id.
-
getTerminalConfiguration
getTerminalConfiguration(feature){TerminalConfiguration}
-
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
andASSETTYPE
fields along side the network source to find out the assigned terminal configuration. If eitherASSETGROUP
,ASSETTYPE
orlayer
are not populated anull
is returned. Returnsnull
if terminal configuration object couldn't be found.Parameterfeature GraphicThe graphic feature to get the terminal configuration from. Must belong to a device layer, and have
ASSETGROUP
andASSETTYPE
fields populated.ReturnsType Description TerminalConfiguration The terminal configuration object. Most devices have a single terminal configuration unless configured otherwise.
-
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.
ParameterdomainNetworkName StringThe name of the domain network.
Returns
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
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"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from Network -
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from Network -
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from Network -
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
load
load(){Promise}
-
Triggers the loading of the UtilityNetwork instance.
Fully loads the utility network definition and all the shared named trace configurations.
Returns
-
queryAssociations
queryAssociations(props){Promise<Association>}
Since: ArcGIS Maps SDK for JavaScript 4.28UtilityNetwork since 4.29, queryAssociations added at 4.28. -
Returns all associations filtered by the QueryAssociationsParameters in a utility network.
ParameterThe parameters required by this functions include QueryAssociationsParameters, what QueryAssociationsParameters of associations to return, QueryAssociationsParameters and more.
ReturnsType Description Promise<Association> When resolved, the list of returned Associations from the query.
-
queryNamedTraceConfigurations
InheritedMethodqueryNamedTraceConfigurations(query, options){Promise<NamedTraceConfiguration[]>}
Inherited from NetworkSince: ArcGIS Maps SDK for JavaScript 4.25Network since 4.20, 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.
Parametersquery ObjectoptionalThe query parameters that are used to determine which named trace configurations will be returned.
Specificationoptional An array of the named trace configuration creators to be queried.
optional An array of named trace configuration globalIds (UUID) to be queried.
optional An array of named trace configuration names to be queried.
optional An array of named trace configuration user tags to be queried.
options RequestOptionsoptionalThe request options specified by the user in the data request. See RequestOptions for available properties.
ReturnsType 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 from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
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");
-
submitTopologyValidationJob
submitTopologyValidationJob(parameters, options){Promise<TopologyValidationJobInfo>}
Since: ArcGIS Maps SDK for JavaScript 4.26UtilityNetwork 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.
Parametersparameters ValidateTopologyPropsThe parameters that are used to validate the network topology.
options RequestOptionsoptionalThe request options specified by the user in the data request. See RequestOptions for available properties.
ReturnsType Description Promise<TopologyValidationJobInfo> Resolves with the results returned from validating network topology. Exampleconst 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
submitTraceJob(props){Promise<TraceJobInfo>}
Since: ArcGIS Maps SDK for JavaScript 4.27UtilityNetwork since 4.29, submitTraceJob added at 4.27. -
Takes the traceProps and preforms an async trace on a UtilityNetwork.
ParametersSpecificationprops ObjectoptionalProps consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType.
SpecificationnamedTraceConfigurationGlobalId StringoptionalThe globalId (UUID) of the named trace configuration persisted in the network.
gdbVersion StringoptionalThe geodatabase version to execute the function against. Defaults to
SDE.DEFAULT
when no version is provided.traceLocations TraceLocation[]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 tonone
.outSpatialReference SpatialReferenceoptionalThe spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).
traceConfiguration UNTraceConfigurationoptionalDefines the properties of a trace.
resultTypes ResultTypeJSON[]optionalParameter specifying the types of results to return after running a trace.
traceTypes StringoptionalThe traceType defined in this trace configuration.
ReturnsType Description Promise<TraceJobInfo> Returns a Promise of TraceJobInfo.
-
synthesizeAssociationGeometries
synthesizeAssociationGeometries(params){Promise<AssociationGeometriesResult>}
Since: ArcGIS Maps SDK for JavaScript 4.28UtilityNetwork since 4.29, synthesizeAssociationGeometries added at 4.28. -
Given an extent, returns all associations within this extent and their synthesized geometries.
ParameterThe parameters required by this functions include extent, what types of associations to return, spatial reference and more
ReturnsType Description Promise<AssociationGeometriesResult> When resolved, the association geomtries result.
-
toJSON
InheritedMethodtoJSON(){Object}
Inherited from Network -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
-
trace
trace(props){Promise<TraceResult>}
Since: ArcGIS Maps SDK for JavaScript 4.27UtilityNetwork since 4.29, trace added at 4.27. -
Takes the traceProps and preforms a trace on a UtilityNetwork.
ParametersSpecificationprops ObjectoptionalProps consists of namedTraceConfigurationGlobalId, traceLocations, outSpatialReference, traceConfiguration, resultTypes, and traceType.
SpecificationnamedTraceConfigurationGlobalId StringoptionalThe globalId (UUID) of the named trace configuration persisted in the network.
gdbVersion StringoptionalThe geodatabase version to execute the function against. Defaults to
SDE.DEFAULT
when no version is provided.traceLocations TraceLocation[]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 tonone
.outSpatialReference SpatialReferenceoptionalThe spatial reference that should be used to project the aggregated geometries returned by the trace (if applicable).
traceConfiguration UNTraceConfigurationoptionalDefines the properties of a trace.
resultTypes ResultTypeJSON[]optionalParameter specifying the types of results to return after running a trace.
traceTypes StringoptionalThe traceType defined in this trace configuration.
ReturnsType Description Promise<TraceResult> Returns a Promise of TraceResult.
-
validateTopology
validateTopology(parameters, options){Promise<ValidateNetworkTopologyResult>}
Since: ArcGIS Maps SDK for JavaScript 4.26UtilityNetwork 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.
Parametersparameters ValidateTopologyPropsThe parameters that are used to validate the network topology.
options RequestOptionsoptionalThe request options specified by the user in the data request. See RequestOptions for available properties.
ReturnsType Description Promise<ValidateNetworkTopologyResult> Resolves with the results returned from validating network topology. Exampleconst 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 });
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from Network -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new promise for the result of callback
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 });
Type Definitions
-
ServiceEdits
ServiceEdits Object
Since: ArcGIS Maps SDK for JavaScript 4.29UtilityNetwork since 4.29, ServiceEdits added at 4.29. -
Results returned from the generateAddAssociations method and generateDeleteAssociations.
- Properties
-
id Number
The layerId of the feature layer.
Identifier for globalId and objectId.
Object of generated add features.
Object of generated delete features.