@arcgis/map-components 5.2.0-next.160 → 5.2.0-next.161

package/dist/components/arcgis-utility-network-trace-functions-result-item/customElement.d.ts

@@ -5,10 +5,48 @@ import type { UtilityNetworkTraceResultItemState } from "../arcgis-utility-netwo
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
- * Trace result item for displaying [function](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#globalFunctionResults) results from a trace.
+ * The Utility Network Trace Functions Result Item component displays the
+ * [function results](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#globalFunctionResults)
+ * returned by a utility network trace. It displays function results in a table with the function
+ * [name](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#functionName)
+ * and [value](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#result).
+ * If a function name is unavailable, the component displays the function result's
+ * [network attribute name](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#networkAttributeName)
+ * and [function type](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#functionType).
+ * Function results without a network attribute name, function type, or result value are not displayed.
+ *
+ * Add this component directly to the default slot of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).
+ * The parent supplies the required read-only
+ * [trace result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/#traceResult) property.
+ *
+ * By default, the [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) component displays the
+ * [aggregated geometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/),
+ * [elements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/), and
+ * [functions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/) result items for the result types
+ * returned by the trace. Adding content to its default slot replaces all default result items. Add each result item
+ * that the custom configuration should display.
  *
  * @since 5.2
+ * @example
+ * The following example displays function results in a custom set of trace result items.
+ * Providing result items in the default slot replaces the parent's default result items.
+ * This example displays only function results.
+ * ```html
+ * <arcgis-map item-id="471eb0bf37074b1fbb972b1da70fb310">
+ *   <arcgis-utility-network-trace-analysis slot="bottom-left">
+ *     <arcgis-utility-network-trace-results slot="results">
+ *       <arcgis-utility-network-trace-functions-result-item
+ *         heading="Function summary"
+ *       ></arcgis-utility-network-trace-functions-result-item>
+ *     </arcgis-utility-network-trace-results>
+ *   </arcgis-utility-network-trace-analysis>
+ * </arcgis-map>
+ * ```
  * @see [Set up functions](https://doc.esri.com/en/arcgis-pro/latest/help/data/utility-network/configure-a-trace.html#CBB)
+ * @see [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/)
+ * @see [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/)
+ * @see [arcgis-utility-network-trace-aggregated-geometry-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/)
+ * @see [arcgis-utility-network-trace-elements-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/)
  */
 export abstract class ArcgisUtilityNetworkTraceFunctionsResultItem extends LitElement {
   /** @internal */
@@ -47,7 +85,10 @@ export abstract class ArcgisUtilityNetworkTraceFunctionsResultItem extends LitEl
    * @default false
    */
   get emitsArcgisResultReady(): true;
-  /** The heading displayed above the result item. */
+  /**
+   * The heading displayed above the function results table.
+   * If not specified or empty, the component uses its localized default heading.
+   */
   accessor heading: string | undefined;
   /**
    * Replace localized message strings with your own strings.
@@ -60,24 +101,30 @@ export abstract class ArcgisUtilityNetworkTraceFunctionsResultItem extends LitEl
       labels?: { functionResults?: string | undefined; } | undefined;
   };
   /**
+   * The processing state of the functions result item.
+   * This property is always `"ready"` because function results require no processing.
+   *
    * @default "ready"
-   * @internal
    */
   get state(): UtilityNetworkTraceResultItemState;
-  /** The trace result containing the function results to render. */
+  /**
+   * The trace result containing the function results to display.
+   * The parent [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) component supplies this property.
+   */
   get traceResult(): TraceResult | undefined;
   /**
-   * Clears the result item.
-   * This result item has no side effects to clear.
-   *
-   * @internal
+   * This method has no effect because the component creates no side effects while processing function results.
+   * Does not emit [@arcgisResultReady](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/#event-arcgisResultReady).
    */
   clearResult(): void;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
   /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
   readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
-  /** Fires when the component is finished rendering its results. */
+  /**
+   * Fires when the component finishes processing the current trace result, including when the result contains no function results.
+   * Calling [clearResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/#clearResult) does not emit this event.
+   */
   readonly arcgisResultReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   readonly "@eventTypes": {
     arcgisPropertyChange: ArcgisUtilityNetworkTraceFunctionsResultItem["arcgisPropertyChange"]["detail"];