UtilityNetwork QML Type

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

Access this property after calling associations or associationsWithType and waiting for the associationsStatus to be complete.

This property was introduced in Esri.ArcGISRuntime 100.14.

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

See also Enums.TaskStatus.

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.

Returns the error object (read-only).

See also Loadable and Error.

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.

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

See also Enums.TaskStatus.

The Geodatabase that contains this UtilityNetwork (read-only).

The Geodatabase that contains this UtilityNetwork and is also used by the GeodatabaseFeatureTable in UtilityNetworkDefinition::networkSources.

Use this property to manage transactions, sync edits, or access tables participating in this UtilityNetwork.

This property has a value when the UtilityNetwork is retrieved from a Geodatabase; otherwise, when created using any of the constructors, this property is null.

Note that calling Geodatabase::close on a Geodatabase that contains this UtilityNetwork will render this UtilityNetwork unusable. An attempt to create an element, get associations, get features from elements, or perform a trace after this Geodatabase is closed will fail with Enums.ErrorTypeGeodatabaseDatabaseClosed.

This property was introduced in Esri.ArcGISRuntime 100.11.

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.

Returns the load error (read-only).

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

See also Loadable.

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.

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

This property was introduced in Esri.ArcGISRuntime 100.8.

The result returned when the asynchronous queryNamedTraceConfigurations(UtilityNamedTraceConfigurationQueryParameters) operation completes (read-only).

This property was introduced in Esri.ArcGISRuntime 100.11.

The current status of the asynchronous queryNamedTraceConfigurations(UtilityNamedTraceConfigurationQueryParameters) operation (read-only).

This property was introduced in Esri.ArcGISRuntime 100.11.

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

The ServiceGeodatabase of the UtilityNetwork (read-only). The ServiceGeodatabase used by the ServiceFeatureTable in UtilityNetworkDefinition::networkSources.

Use this property to switch to a branch version, manage edits, or query related records of tables participating in this UtilityNetwork.

This property is null until the UtilityNetwork is loaded. The Map that was used to create this UtilityNetwork provides this ServiceGeodatabase. When no matching ServiceGeodatabase is found in the Map, this UtilityNetwork will create and load a ServiceGeodatabase connected to the default version in Enums.FeatureServiceSessionTypeTransient mode.

Note that calling ServiceGeodatabase::close on a ServiceGeodatabase that is used by a UtilityNetwork will render this UtilityNetwork unusable. An attempt to create an element, get associations, get features from elements, or perform a trace after this ServiceGeodatabase is closed will fail with Error::code 3078, indicating GeodatabaseDatabaseClosed.

This property was introduced in Esri.ArcGISRuntime 100.10.

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.

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

See also Enums.TaskStatus.

The URL to utility network feature service.

Emitted when the associationsResults property changes.

Note: The corresponding handler is onAssociationsStatusChanged.

Emitted when the credential property of this UtilityNetwork changes.

Note: The corresponding handler is onCredentialChanged.

Emitted when the definition property changes.

Note: The corresponding handler is onDefinitionChanged.

Emitted when the featuresForElementsStatus property changes.

Note: The corresponding handler is onFeaturesForElementsStatusChanged.

Emitted when the initMap property changes.

Note: The corresponding handler is onInitMapChanged.

Emitted when the loadError property of this UtilityNetwork changes.

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

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.

Emitted when the loadStatus property of this UtilityNetwork changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.

Emitted when the queryNamedTraceConfigurationsStatus property changes.

Note: The corresponding handler is onQueryNamedTraceConfigurationsStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.11.

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.

Emitted when the traceStatus property changes.

Note: The corresponding handler is onTraceStatusChanged.

Emitted when the url property of this UtilityNetwork changes.

Note: The corresponding handler is onUrlChanged.

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 method was introduced in Esri.ArcGISRuntime 100.7.

See also associationsResults and associationsStatusChanged.

Starts a task to get a list of all UtilityAssociation objects (with their geometry) present in the geodatabase for the 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 method was introduced in Esri.ArcGISRuntime 100.8.

See also associationsResults and associationsStatusChanged.

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

Containment associations are not returned because no geometric relationship is defined between a container and its contents; consider using UtilityNetwork::associationsWithType() instead. 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 method was introduced in Esri.ArcGISRuntime 100.8.

See also Enums.UtilityAssociationType, associationsResults, and associationsStatusChanged.

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

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 method was introduced in Esri.ArcGISRuntime 100.7.

See also Enums.UtilityAssociationType, associationsResults, and associationsStatusChanged.

See also Loadable.

Cancel the task with the ID taskId.

Returns false if the task cannot be canceled or there is no task with the specified id taskId.

See also Cancelable.

Creates a UtilityElement from an ArcGISFeature and an optional UtilityTerminal.

• arcGISFeature - The ArcGISFeature
• terminal - The UtilityTerminal (optional and may be omitted entirely)

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

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

• assetType - The UtilityAssetType
• globalId - The global ID if the
• terminal - The UtilityTerminal (optional and may be omitted entirely)

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";

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.

See also Loadable.

Returns a list of UtilityNamedTraceConfiguration from the utility network.

• queryParameters - Optional query parameter to filter the results.

Returns a string representing the task ID of the asynchronous task.

This method was introduced in Esri.ArcGISRuntime 100.11.

See also UtilityNamedTraceConfigurationQueryParameters.

See also Loadable.

Begins a trace with the supplied trace parameters.

• traceParameters - The UtilityTraceParameters to use for this trace.

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