require(["esri/rest/networks/trace"], (trace) => { /* code goes here */ });
import * as trace from "@arcgis/core/rest/networks/trace.js";
esri/rest/networks/trace
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
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Promise<TraceResult> | The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results. | trace |
Method Details
-
trace
Methodtrace(url, params, requestOptions){Promise<TraceResult>} -
The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a UttilityNetwork.
params TraceParametersThe list of parameters required by the trace
requestOptions ObjectoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<TraceResult> When resolved, returns the trace results which could include elements, function results or aggregated geometries.