Class: @arcgis/core/networks/Network
Since: ArcGIS Maps SDK for JavaScript 4.20
Class defining high level properties that describes utility networks and trace networks.
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.
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.
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)
The Error object returned if an error occurred while loading.
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"
loadWarnings Object[]readonly
A list of warnings which occurred while loading.
loaded Booleanreadonly
Indicates whether the network instance has loaded. When true, all the properties of the object can be accessed.
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.
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.
sourceJSON Object
The spatial reference of the network, defined at the creation of the network, usually from the service territory class.
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"
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.
cancelLoad()
Cancels a load() operation if it is already in progress.
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. fromPortalItem(params){Promise<UtilityNetwork>}static
Creates a new network instance from an ArcGIS Online or ArcGIS Enterprise portal item.
Parameters
The parameters for loading the portal item.
Specification
The object representing an ArcGIS Online or ArcGIS Enterprise portal item from which to load the network.
Returns
Type 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);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
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.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");
} 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). 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. 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. load(options){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 a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.
Parameters
optionalAdditional options.
Specification
optionalSignal 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.
Returns
Type Description Promise Resolves when the resources have loaded. load(){Promise}
Triggers the loading of the network instance.
Fully loads the network definition and all related objects (e.g. trace configurations)
Returns
Type Description Promise Resolves when the Network is loaded.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 Network since 4.31, 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}"]
}
]
});Since: ArcGIS Maps SDK for JavaScript 4.26 Network since 4.31, 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 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 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: 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
}); LayerInfo Object
Since: ArcGIS Maps SDK for JavaScript 4.31 Network since 4.31, LayerInfo added at 4.31.
Contains layerUrl, objectIds, and outFields.
The layerUrl of the feature layer.
The objectIds of the elements.
optionalThe outFields of a layer.
Since: ArcGIS Maps SDK for JavaScript 4.33 Network since 4.31, NetworkDataElementJSON added at 4.33.
Contains the full network definition.
An array of domain networks included in the utility network.
The name of the domain network.
An array of network source objects that represent the sources of junction features.
The layer Id of the junction source.
The source Id of the junction source.
An array of asset groups defined for the junction source.
The unique code for the asset group.
optionalThe name of the asset group.
An array of asset types associated with the asset group.
The unique code for the asset type.
optionalThe name of the asset type.
isTerminalConfigurationSupported Boolean optionalIndicates if terminal configurations are supported for the asset type.
optionalThe terminal configuration Id associated with the asset type, if applicable.
optionalThe connectivity policy applied to the asset type.
An array of network source objects that represent the sources of edge features.
The layer Id of the edge source.
The source Id of the edge source.
An array of asset groups defined for the edge source.
The unique code for the asset group.
optionalThe name of the asset group.
An array of asset types associated with the asset group.
The unique code for the asset type.
optionalThe name of the asset type.
isTerminalConfigurationSupported Boolean optionalIndicates if terminal configurations are supported for the asset type.
optionalThe terminal configuration Id associated with the asset type, if applicable.
optionalThe connectivity policy applied to the asset type.
An array of tier definitions used to organize the network into hierarchical levels. Null if no tiers are defined.
The layer Id of the subnetwork layer. Null if no subnetwork layer is defined.
optionalA UNTraceConfiguration object that defines the trace configuration for the domain network. This configuration includes parameters specific to utility networks.
The user identity associated with the network definition.
The name of the utility network.
The schema generation version number of the utility network.
An array of terminal configuration objects available in the network.
The Id that uniquely identifies the terminal configuration.
The layer Id of the feature layer representing service territories within the network.
ValidateTopologyProps
Since: ArcGIS Maps SDK for JavaScript 4.27 Network since 4.31, ValidateTopologyProps added at 4.27.
ValidateTopologyProps represents the parameters for validating a network topology.
gdbVersion of the Network to trace a specific gdbVersion. optional
Specifies the geodatabase version name. Defaults to SDE.DEFAULT when no version is provided.
Specifies the GUID used to lock the version. If the client is editing SDE.DEFAULT, the sessionID should not be used because this version cannot be locked.
Specifies the envelope of the area to validate. This property is required.
optionalSpecifies the set of features and objects to validate.
optionalSpecifies the validation to perform.
Possible Values:"normal"|"rebuild"|"force-rebuild"
Example
const validationResult = await network.validateTopology({
validateArea: extent,
gdbVersion: "sde.DEFAULT",
validationType: "rebuild",
validationSet: [
{
sourceId: 4134325151,
globalIds: ["{7865BAA6-ED9C-4346-9F72-894A49E10C73}"]
}
]
});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