esri/networks/Network
Class defining high level properties that describes utility networks and trace networks.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Object | The full network definition, accessible only when the network is loaded. more details | Network | |
String | The physical dataset name of the network as defined in the backend database. more details | Network | |
String | The name of the class. more details | Accessor | |
String | Returns the root feature service url which this network is part of. more details | Network | |
Extent | The full extent of the network, defined from the service territory used to create the network. more details | Network | |
String | The version of the geodatabase of the feature service data. more details | gdbVersion | |
Date | The historic moment to query. more details | historicMoment | |
String | Random unique id (UUID) to identify a network as defined in the webmap spec. more details | Network | |
Number | The layer id of the network. more details | Network | |
String | The full url to the network layer id as defined in the webmap spec. more details | Network | |
Boolean | Indicates whether the network instance has loaded. more details | Network | |
Error | The Error object returned if an error occurred while loading. more details | Network | |
String | Represents the status of a load operation. more details | Network | |
Object[] | A list of warnings which occurred while loading. more details | Network | |
String | Returns the url of network server. more details | Network | |
NetworkSystemLayers | Contains the url and IDs of the utility network rules, subnetworks, and dirty areas tables or layers. more details | Network | |
String | The portal user owner of the network. more details | Network | |
String | Converts url to a url object more details | Network | |
Number | The schema version of the network. more details | Network | |
Object | more details | Network | |
SpatialReference | The spatial reference of the network, defined at the creation of the network, usually from the service territory class. more details | Network | |
String | The name of the network as defined in the webmap spec. more details | Network | |
String | The type of the dataset. more details | Network |
Property Details
-
dataElement Object
-
The full network definition, accessible only when the network is loaded.
-
datasetName Stringreadonly
-
The physical dataset name of the network as defined in the backend database. Accessible only when the network is loaded.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
featureServiceUrl Stringreadonly
-
Returns the root feature service url which this network is part of.
Example`https://utilitynetwork.esri.com/server/rest/services/NapervilleElectric/FeatureServer/`
-
fullExtent Extent
-
The full extent of the network, defined from the service territory used to create the network.
-
gdbVersion Stringinner
-
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.
-
id String
-
Random unique id (UUID) to identify a network as defined in the webmap spec. Generated during sharing of the webmap.
-
layerId Numberreadonly
-
The layer id of the network.
-
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)
-
loaded Booleanreadonly
-
Indicates whether the network instance has loaded. When
true
, all the properties of the object can be accessed.- Default Value:false
-
loadError Errorreadonly
-
The Error object returned if an error occurred while loading.
- Default Value:null
-
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
-
A list of warnings which occurred while loading.
-
networkServiceUrl Stringreadonly
-
Returns the url of network server.
Example`https://utilitynetwork.esri.com/server/rest/services/NapervilleElectric/UtilityNetworkServer/`
-
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}`); } });
-
owner Stringreadonly
-
The portal user owner of the network. This portal user can perform administrive actions against the network.
-
parsedUrl Stringreadonly
-
Converts url to a url object
-
schemaGeneration Numberreadonly
-
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.
-
sourceJSON Object
-
-
spatialReference SpatialReference
-
The spatial reference of the network, defined at the creation of the network, usually from the service territory class.
-
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 or "trace" in case the network is a trace network.
Possible Values:"utility"|"trace"
- 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. more details | Accessor | ||
Cancels a load() operation if it is already in progress. more details | Network | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | Network | |
Promise<UtilityNetwork> | Creates a new network instance from an ArcGIS Online or ArcGIS Enterprise portal item. more details | Network | |
Number | The network consists of sources (classes) and each source has a unique Id. more details | Network | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Network | |
Boolean |
| Network | |
Boolean |
| Network | |
Promise | Triggers the loading of the network instance. more details | Network | |
Promise | Loads the resources referenced by this class. more details | Network | |
Promise<NamedTraceConfiguration[]> | 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. more details | Network | |
Removes a group of handles owned by the object. more details | Accessor | ||
Promise<TopologyValidationJobInfo> | Whenever the network is edited or modified, the network and its features become out of date in the network topology. more details | Network | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | Network | |
Promise<ValidateNetworkTopologyResult> | Whenever the network is edited or modified, the network and its features become out of date in the network topology. more details | Network | |
Promise |
| Network |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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.
-
cancelLoad()
-
Cancels a load() operation if it is already in progress.
-
fromJSON(json){*}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.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.
-
-
Creates a new network instance from an ArcGIS Online or ArcGIS Enterprise portal item.
Known Limitations This method does not populate the sharedNamedTraceConfigurations for a UtilityNetwork instance.
Parametersparams ObjectThe parameters for loading the portal item.
SpecificationportalItem PortalItemThe object representing an ArcGIS Online or ArcGIS Enterprise portal item from which to load the network.
ReturnsType Description Promise<UtilityNetwork> Returns a promise which resolves to the new utility network instance. Example// Create a utility network from a specified portal item that contains a utility network feature service const item = new PortalItem({ id: "77c7ae75eb3e4e08a7ad98cb37fefe88", }); const utilityNetwork = await UtilityNetwork.fromPortalItem(item); await utilityNetwork.load(); console.log("utilityNetwork loaded? ", utilityNetwork.loadStatus);
-
getLayerIdBySourceId(id){Number}
-
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.
-
Since: ArcGIS Maps SDK for JavaScript 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(){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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
load(){Promise}
-
Triggers the loading of the network instance.
Fully loads the network definition and all related objects (e.g. trace configurations)
ReturnsType Description Promise Resolves when the Network is loaded.
-
load(signal){Promise}
-
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The
load()
method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.It's possible to provide a
signal
to stop being interested into aLoadable
instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.Parametersignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when 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 Resolves when the resources have loaded.
-
queryNamedTraceConfigurations(query, options){Promise<NamedTraceConfiguration[]>}Since: ArcGIS Maps SDK for JavaScript 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);
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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(parameters, options){Promise<TopologyValidationJobInfo>}Since: ArcGIS Maps SDK for JavaScript 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}"] } ] });
-
toJSON(){Object}
-
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.
-
validateTopology(parameters, options){Promise<ValidateNetworkTopologyResult>}Since: ArcGIS Maps SDK for JavaScript 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<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(callback, errback){Promise}
-
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.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType 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
-
ValidateTopologyPropsSince: ArcGIS Maps SDK for JavaScript 4.27
-
ValidateTopologyProps represents the parameters for validating a network topology.
- Properties
-
gdbVersion String
Specifies the geodatabase version name. Defaults to
SDE.DEFAULT
when no version is provided.sessionID StringSpecifies the GUID used to lock the version. If the client is editing
SDE.DEFAULT
, thesessionID
should not be used because this version cannot be locked.validateArea ExtentSpecifies the envelope of the area to validate. This property is required.
validationSet ValidationSetItemJSON[]Specifies the set of features and objects to validate.
validationType StringSpecifies the validation to perform.
Possible Values:"normal"|"rebuild"|"force-rebuild"
Exampleconst validationResult = await network.validateTopology({ validateArea: extent, gdbVersion: "sde.DEFAULT", validationType: "rebuild", validationSet: [ { sourceId: 4134325151, globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"] } ] });