import { trace } from "@arcgis/core/rest/networks/trace.js";const { trace } = await $arcgis.import("@arcgis/core/rest/networks/trace.js");- Since
- ArcGIS Maps SDK 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
Functions
| Name | Return Type | Object |
|---|---|---|
| |
trace
The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results.
- Signature
-
trace (url: string, params: TraceParameters, requestOptions?: RequestOptions): Promise<TraceResult>
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| url | URL to the ArcGIS Server REST resource that represents a UttilityNetwork. | | |
| params | The list of parameters required by the trace | | |
| requestOptions | Additional options to be used for the data request. | |
- Returns
- Promise<TraceResult>
When resolved, returns the trace results which could include elements, function results or aggregated geometries.