@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/networks/UtilityNetworkTraceAnalysis.d.ts

@@ -7,6 +7,7 @@ import type TraceResult from "../rest/networks/support/TraceResult.js";
 import type MapView from "../views/MapView.js";
 import type { TraceType } from "./support/typeUtils.js";
 
+/** @since 5.0 */
 export interface UtilityNetworkTraceAnalysisProperties extends Partial<Pick<UtilityNetworkTraceAnalysis, "utilityNetwork" | "view">> {}
 
 /**
@@ -15,17 +16,31 @@ export interface UtilityNetworkTraceAnalysisProperties extends Partial<Pick<Util
  * @since 4.34
  */
 export interface TraceConfigurationParameters {
-  /** The desired out [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) of the trace. */
+  /**
+   * The desired out [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) of the trace.
+   *
+   * @since 5.0
+   */
   outSpatialReference?: SpatialReference;
-  /** The collection of trace configuration properties. Depending on the trace type, some of the trace configuration properties are required. */
+  /**
+   * The collection of trace configuration properties. Depending on the trace type, some of the trace configuration properties are required.
+   *
+   * @since 5.0
+   */
   traceConfiguration: UNTraceConfiguration;
   /**
    * To perform the trace analytic, users can optionally supply a list of locations in forms of globalIds (UUID) and terminals. These locations indicate starting points and barriers.
    * A [starting point](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/starting-points.htm) is set on network features to define the location in the network where a trace begins. Most traces require one or more starting points to be defined. [Barriers](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/barriers.htm) are used in traces, export subnetwork operations, and update subnetwork operations to mark the locations to stop tracing.
    * Use barriers to represent a location in the network beyond which the trace cannot travel.
+   *
+   * @since 5.0
    */
   traceLocations?: TraceLocation[];
-  /** The trace type. This specifies the core algorithm that will be run to analyze the network. */
+  /**
+   * The trace type. This specifies the core algorithm that will be run to analyze the network.
+   *
+   * @since 5.0
+   */
   traceType: TraceType;
 }
 
@@ -35,22 +50,35 @@ export interface TraceConfigurationParameters {
  * @since 4.32
  */
 export interface NamedTraceConfigurationParameters {
-  /** The globalId of the named trace configuration. */
+  /**
+   * The globalId of the named trace configuration.
+   *
+   * @since 5.0
+   */
   namedTraceConfigurationGlobalId: string;
-  /** The desired out [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) of the trace. */
+  /**
+   * The desired out [SpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) of the trace.
+   *
+   * @since 5.0
+   */
   outSpatialReference?: SpatialReference;
   /**
    * To perform the trace analytic, users can optionally supply a list of locations in forms of globalIds (UUID) and terminals. These locations indicate starting points and barriers.
    * A [starting point](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/starting-points.htm) is set on network features to define the location in the network where a trace begins. Most traces require one or more starting points to be defined. [Barriers](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/barriers.htm) are used in traces, export subnetwork operations, and update subnetwork operations to mark the locations to stop tracing.
    * Use barriers to represent a location in the network beyond which the trace cannot travel.
+   *
+   * @since 5.0
    */
   traceLocations?: TraceLocation[];
 }
 
+/** @since 5.0 */
 export type UtilityNetworkTraceAnalysisExecutionError = "trace-error";
 
+/** @since 5.0 */
 export type UtilityNetworkTraceAnalysisLoadError = "no-user-type-extension" | "no-utility-network" | "no-view" | "sceneView-not-supported";
 
+/** @since 5.0 */
 export type UtilityNetworkTraceAnalysisState = "disabled" | "executing" | "loading" | "ready";
 
 /**
@@ -60,22 +88,44 @@ export type UtilityNetworkTraceAnalysisState = "disabled" | "executing" | "loadi
  * @see [UtilityNetwork](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html)
  */
 export default class UtilityNetworkTraceAnalysis extends Accessor {
+  /** @since 5.0 */
   constructor(properties?: UtilityNetworkTraceAnalysisProperties);
-  /** Displays execution errors. */
+  /**
+   * Displays execution errors.
+   *
+   * @since 5.0
+   */
   get executionError(): UtilityNetworkTraceAnalysisExecutionError | null | undefined;
-  /** Displays an error if loading fails. */
+  /**
+   * Displays an error if loading fails.
+   *
+   * @since 5.0
+   */
   get loadError(): UtilityNetworkTraceAnalysisLoadError | null | undefined;
-  /** The current state of this object. */
+  /**
+   * The current state of this object.
+   *
+   * @since 5.0
+   */
   get state(): UtilityNetworkTraceAnalysisState;
-  /** Determines the utility network to use. */
+  /**
+   * Determines the utility network to use.
+   *
+   * @since 5.0
+   */
   accessor utilityNetwork: UtilityNetwork | null | undefined;
-  /** This property defines the target [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). */
+  /**
+   * This property defines the target [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   *
+   * @since 5.0
+   */
   accessor view: MapView | null | undefined;
   /**
    * Method used to execute a trace using a named trace configuration.
    *
    * @param parameters - The parameters used to execute a trace based using named trace configurations.
    * @returns When resolved, returns the trace results which could include elements, function results or aggregated geometries.
+   * @since 5.0
    * @example
    * const traceLocations = [
    *  {
@@ -100,6 +150,7 @@ export default class UtilityNetworkTraceAnalysis extends Accessor {
    *
    * @param parameters - The parameters used to execute a custom trace.
    * @returns When resolved, returns the trace results which could include elements, function results or aggregated geometries.
+   * @since 5.0
    * @example
    * const traceConfiguration = new UNTraceConfiguration({
    *   domainNetworkName: "ElectricDistribution",