Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityNetwork QML Type

A utility network More...

Import Statement: import Esri.ArcGISRuntime 100.8
Since: Esri.ArcGISRuntime 100.6
Inherits:

Object

Properties

Signals

Methods

Detailed Description

This is the central class for ArcGIS utility network schema information and tracing.

Use this type to access network schema information and perform tracing operations. UtilityNetwork follows the Loadable pattern. When it loads, it is populated with the utility network schema. This class provides methods to create UtilityElement objects for the UtilityNetwork.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

A UtilityNetwork may be created from the following combinations of properties:

See also Cancelable, Loadable, and RemoteResource.

Property Documentation

associationsResult : list<UtilityAssociation>

Returns the list of UtilityAssociation objects from an associations operation (read-only).

Access this property after calling associations or associationsWithType(UtilityElement element, Enums.UtilityAssociationType type) and waiting for the associationsStatus to be complete.


associationsStatus : Enums.TaskStatus

Returns the associationStatus of the associations and associationsWithType methods (read-only).

See also Enums.TaskStatus.


[default] credential : Credential

The credential to be used for a secured utility network feature service.


Returns the definition of the UtilityNetwork (read-only).

The definition contains metadata about the associated utility network feature service.


error : Error

Returns the error object (read-only).

See also Loadable and Error.


featuresForElementsResult : ArcGISFeatureListModel

Returns the list model of features that is the result of the featuresForElements task (read-only).

The returned list model will contain loaded ArcGISFeature objects corresponding to the collection of UtilityElement objects used in the task.


featuresForElementsStatus : Enums.TaskStatus

Returns the featuresForElementsStatus of the UtilityNetwork featuresForElements method (read-only).

See also Enums.TaskStatus.


initMap : Map

The map used to initialize the UtilityNetwork.

Any UtilityElement or ArcGISFeature objects that the UtilityNetwork creates or uses will be associated with the existing tables and layers inside the Map.

Note: When using the initMap property to instantiate a UtilityNetwork, you must also set the url property. Providing only the initMap property will leave the UtilityNetwork object in an undefined state.


loadError : Error

Returns the load error (read-only).

Note: Load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by this task.


Returns the list model of UtilityTraceResult object from a trace operation (read-only).

Access this property after calling trace and waiting for the traceStatus to be complete.


traceStatus : Enums.TaskStatus

Returns the traceStatus of the UtilityNetwork trace method (read-only).

See also Enums.TaskStatus.


url : url

The URL to utility network feature service.


Signal Documentation

associationsStatusChanged()

Emitted when the associationsStatus property changes.


credentialChanged()

Emitted when the credential property of this UtilityNetwork changes.


definitionChanged()

Emitted when the definition property changes.


featuresForElementsStatusChanged()

Emitted when the featuresForElementsStatus property changes.


initMapChanged()

Emitted when the initMap property changes.


loadErrorChanged()

Emitted when the loadError property of this UtilityNetwork changes.

Note: Load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property of this UtilityNetwork changes.

See also Loadable.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.


traceStatusChanged()

Emitted when the traceStatus property changes.


urlChanged()

Emitted when the url property of this UtilityNetwork changes.


Method Documentation

string associations(UtilityElement element)

Starts a task to get a list of all UtilityAssociation objects present in the geodatabase for a given element.

The result is a list of all associations - connectivity associations, containment associations, structural attachment associations - that include the given UtilityElement object.

The method does not return a complete picture of connectivity. Features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.

Returns the task ID for the new task.

This QML method was introduced in Esri.ArcGISRuntime 100.7.

See also associationsResult and associationsStatusChanged.


string associationsWithEnvelope(Envelope envelope)

Starts a task to get a list of all UtilityAssociation objects (with their geometry) present in the geodatabase for a given Envelope.

The result is a list of connectivity and structural attachment associations. Containment associations are not returned because no geometric relationship is defined between a container and its contents. The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.

Returns the task ID for the new task.

This QML method was introduced in Esri.ArcGISRuntime 100.8.

See also associationsResult and associationsStatusChanged.


void cancelLoad()

See also Loadable.


bool cancelTask(string taskId)

See also Cancelable.


UtilityElement createElementWithArcGISFeature(ArcGISFeature arcGISFeature, UtilityTerminal terminal)

Creates a UtilityElement from an ArcGISFeature and an optional UtilityTerminal.

If a UtilityTerminal is omitted, and if the feature's UtilityAssetType supports a UtilityTerminalConfiguration, a default UtilityTerminal will be assigned.


UtilityElement createElementWithAssetType(UtilityAssetType assetType, string globalId, UtilityTerminal terminal)

Creates a UtilityElement from an UtilityAssetType, a global ID, and an optional UtilityTerminal.

If a UtilityTerminal is not supplied, and if the feature's UtilityAssetType supports a UtilityTerminalConfiguration, a default UtilityTerminal will be assigned.

Note: The following formats of UUID will be accepted for the globalId parameter:

const guid1 = "{221F7A6F-1234-4C7E-AB59-B71C16B7C3B0}";
const guid2 = "221F7A6F-1234-4C7E-AB59-B71C16B7C3B0";
const guid3 = "{221f7a6f-1234-4c7e-ab59-b71c16b7c3b0}";
const guid4 = "221f7a6f-1234-4c7e-ab59-b71c16b7c3b0";

string featuresForElements(list<UtilityElement> elements)

Asynchronous method to request the features associated with a list of elements.

The result list model will contain loaded ArcGISFeature objects corresponding to the collection of UtilityElement objects used in the task.

See also featuresForElementsResult.


void load()

See also Loadable.


void retryLoad()

See also Loadable.


string trace(UtilityTraceParameters traceParameters)

Begins a trace with the supplied trace parameters.

After the traceStatus indicates that the trace task is finished, access the results through the traceResult property.



Feedback on this topic?