@arcgis/core/rest/networks/trace.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

/**
 * 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.
 *
 * @since 4.20
 * @see [Learn more about tracing](https://pro.arcgis.com/en/pro-app/2.7/help/data/utility-network/about-tracing-utility-networks.htm)
 */
import type TraceParameters from "./support/TraceParameters.js";
import type TraceResult from "./support/TraceResult.js";
import type { RequestOptions } from "../../request/types.js";

/**
 * The trace function takes a set of parameters, executes the trace analytic on the backend, and returns trace results.
 *
 * @param url - URL to the ArcGIS Server REST resource that represents a UttilityNetwork.
 * @param params - The list of parameters required by the trace
 * @param requestOptions - Additional [options](https://developers.arcgis.com/javascript/latest/references/core/request/#request) to be used for the data request.
 * @returns When resolved, returns the trace results which could include elements, function results or aggregated geometries.
 */
export function trace(url: string, params: TraceParameters, requestOptions?: RequestOptions): Promise<TraceResult>;