@arcgis/map-components 5.2.0-next.7 → 5.2.0-next.71

package/dist/components/arcgis-utility-network-trace-inputs/customElement.d.ts

@@ -13,8 +13,6 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
  * This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.
- *
- * This sub-component takes a map view as an input.
  * It allows users to select utility networks, trace configurations, and input features for tracing.
  *
  * @since 4.34
@@ -131,15 +129,29 @@ export abstract class ArcgisUtilityNetworkTraceInputs extends LitElement {
    */
   accessor hideActionBar: boolean;
   /**
+   * Whether a the user has selected a named trace configuration that executes a
+   * subnetwork trace with a specified subnetwork name.
+   *
    * @default false
    * @internal
    */
   get isSubnetworkNameTraceSelected(): boolean;
   /** @default "default" */
   accessor mode: UtilityNetworkTraceAnalysisDisplayMode;
+  /**
+   * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
+   *
+   * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+   */
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
   accessor selectedNamedTraceConfiguration: NamedTraceConfiguration | undefined;
   accessor selectedUtilityNetwork: UtilityNetwork | undefined;
+  /**
+   * A clone of the utility network trace configuration associated with
+   * the selected named trace configuration. Updates on this object are
+   * used to reflect the user's changes to the named trace configuration.
+   */
+  get traceConfiguration(): UNTraceConfiguration | undefined;
   /**
    * Supplementary information about the points selected on the map to run the trace.
    * I.e., feature title, terminal configuration, selected terminals, and spatial properties.
@@ -149,19 +161,15 @@ export abstract class ArcgisUtilityNetworkTraceInputs extends LitElement {
   get traceLocationFlagInfos(): Collection<FlagInfo>;
   get traceLocations(): TraceLocation[];
   /**
-   * A clone of the utility network trace configuration associated with
-   * the selected named trace configuration. Updates on this object are
-   * used to reflect the user's changes to the named trace configuration.
+   * The view associated with the component.
+   * > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-trace-inputs component will be associated with a map or scene component rather than using the `view` property.
    */
-  get unTraceConfiguration(): UNTraceConfiguration | undefined;
-  /** @required */
   accessor view: MapView | undefined;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
   readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "mode"; }>;
   /** Fires when the user changes the selected named trace configuration. */
   readonly arcgisSelectedNamedTraceConfigurationChange: import("@arcgis/lumina").TargetedEvent<this, void>;
-  /** There will be more added to this event as we increase the functionality of this component */
   readonly arcgisTraceInputsChange: import("@arcgis/lumina").TargetedEvent<this, void>;
   /**
    * Fires when the user completes the selection of a trace location.
@@ -176,7 +184,7 @@ export abstract class ArcgisUtilityNetworkTraceInputs extends LitElement {
    * @internal
    */
   readonly arcgisTraceLocationSelectStart: import("@arcgis/lumina").TargetedEvent<this, SelectStartPayload>;
-  /** This will be fired less often than above, only when the utility network changes */
+  /** Fires when the user changes the selected utility network. */
   readonly arcgisUtilityNetworkChange: import("@arcgis/lumina").TargetedEvent<this, void>;
   readonly "@eventTypes": {
     arcgisPropertyChange: ArcgisUtilityNetworkTraceInputs["arcgisPropertyChange"]["detail"];