Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityTraceParameters QML Type

Utility network trace parameters. More...

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

Object

Properties

Signals

Detailed Description

See also UtilityNetwork::trace.

Property Documentation

barriers : list<UtilityElement>

The list of barriers to use in the trace operation.

Barriers are used in traces to mark the locations to stop tracing.

To update the barriers list, assign a new JavaScript array that contains the desired elements:

params.barriers = [barrier1, barrier2, barrier3];

resultTypes : list<Enums.UtilityTraceType>

Returns a collection that is pre-populated with the server default of Enums.UtilityTraceResultTypeElements.

This corresponds to the UtilityTraceResult collection returned by UtilityNetwork::trace.

See also Enums.UtilityTraceType.


startingLocations : list<UtilityElement>

The list of starting locations to use in the trace operation.

A starting point defines the location in the network where a trace begins.

To update the starting location list, assign a new JavaScript array that contains the desired elements:

params.startingLocations = [location1, location2, location3];

traceConfiguration : UtilityTraceConfiguration

The complete collection of trace options.

This property was introduced in Esri.ArcGISRuntime 100.7.


traceType : Enums.UtilityTraceType

The traceType of the UtilityTraceParameters.

See also Enums.UtilityTraceType.


Signal Documentation

barriersChanged()

Emitted when the barriers property changes.

Note: The corresponding handler is onBarriersChanged.


resultTypesChanged()

Emitted when the resultTypes property changes.

Note: The corresponding handler is onResultTypesChanged.


startingLocationsChanged()

Emitted when the startingLocations property changes.

Note: The corresponding handler is onStartingLocationsChanged.


traceConfigurationChanged()

Emitted when the traceConfiguration property changes.

Note: The corresponding handler is onTraceConfigurationChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.


traceTypeChanged()

Emitted when the traceType property changes.

Note: The corresponding handler is onTraceTypeChanged.



Feedback on this topic?