trace

AMD: require(["esri/rest/networks/trace"], (trace) => { /* code goes here */ });

ESM: import * as trace from "@arcgis/core/rest/networks/trace";

Object: esri/rest/networks/trace

Since: ArcGIS API for JavaScript 4.20

Trace is the core analytic of the utility network, by providing a set of parameters, you can start the trace in one or more features and traverse the network topology satisfying the parameters until the trace stops at end points or when the definition of the trace condition barriers are met. The trace returns a collection of elements and their source, function results, diagram or aggregated geometries.

See also:

Learn more about tracing

Method Overview

Name	Return Type	Summary	Object
	Promise<TraceResult>	more details The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results.	more details	trace

Method Details

trace(url, params, requestOptions){Promise<TraceResult>}

The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results.

Parameters:

url String

URL to the ArcGIS Server REST resource that represents a UttilityNetwork.

params TraceParameters

The list of parameters required by the trace

requestOptions Object

optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:

Type	Description
Promise<TraceResult>	When resolved, returns the trace results which could include elements, function results or aggregated geometries.

ArcGIS API for JavaScriptAPI Reference

trace

Was this page helpful?

Was this page helpful?