@arcgis/map-components 5.2.0-next.111 → 5.2.0-next.112

package/dist/components/arcgis-utility-network-trace-locations/customElement.js

@@ -12,13 +12,13 @@ import T from "@arcgis/core/rest/networks/support/TraceLocation.js";
 import k from "@arcgis/core/symbols/SimpleMarkerSymbol.js";
 import B from "@arcgis/core/widgets/Sketch/SketchViewModel.js";
 import { LitElement as N, createEvent as S } from "@arcgis/lumina";
-import { log as d, composeMissingPropertyMessage as b } from "@arcgis/toolkit/log";
+import { log as u, composeMissingPropertyMessage as b } from "@arcgis/toolkit/log";
 import { u as q } from "../../chunks/useT9n.js";
-import { a as D, c as j, d as G, b as H } from "../../chunks/layer-utils.js";
+import { a as D, c as j, d as G, i as H } from "../../chunks/layer-utils.js";
 import { css as O, html as p } from "lit";
 import v from "@arcgis/core/views/interactive/snapping/FeatureSnappingLayerSource.js";
 import { substitute as U } from "@arcgis/core/intl.js";
-const W = O`calcite-block{--calcite-block-content-space: 0;--calcite-block-border-color: transparent;margin:0}.add-location-button{--calcite-button-border-color: var(--calcite-color-border-1);--calcite-button-icon-color: var(--calcite-color-text-1);--calcite-button-text-color: var(--calcite-color-text-1)}.button-container{display:flex;justify-content:center}calcite-list{padding:0 var(--calcite-space-sm) var(--calcite-space-sm);background-color:var(--calcite-color-surface-2);border:solid 1px var(--calcite-color-border-3);border-radius:var(--calcite-corner-radius-sm);overflow:hidden}calcite-list-item[selected] [slot=content-bottom]{display:block}.warning{color:var(--calcite-color-status-danger)}.terminals{padding:var(--calcite-space-sm) var(--calcite-space-md);display:flex;flex-direction:column}.filter-barrier{display:flex;justify-content:space-between;align-items:center;width:100%}`, $ = `utility-network-trace-locations-sketch-${Date.now()}`;
+const W = O`calcite-block{--calcite-block-content-space: 0;--calcite-block-border-color: transparent;margin:0}.add-location-button{--calcite-button-border-color: var(--calcite-color-border-1);--calcite-button-icon-color: var(--calcite-color-text-1);--calcite-button-text-color: var(--calcite-color-text-1)}.button-container{display:flex;justify-content:center}calcite-list{margin:0 var(--calcite-space-sm) var(--calcite-space-sm);background-color:var(--calcite-color-surface-2);border:solid 1px var(--calcite-color-border-3);border-radius:var(--calcite-corner-radius-sm);overflow:hidden}calcite-list-item[selected] [slot=content-bottom]{display:block}.warning{color:var(--calcite-color-status-danger)}.terminals{padding:var(--calcite-space-sm) var(--calcite-space-md);display:flex;flex-direction:column}.filter-barrier{display:flex;justify-content:space-between;align-items:center;width:100%}`, $ = `utility-network-trace-locations-sketch-${Date.now()}`;
 class x extends N {
   constructor() {
     super(...arguments), this._messages = q({ blocking: !0 }), this._isSelectWaiting = !1, this.traceLocationType = "starting-point", this.traceLocations = new L(), this.filterLayers = new L(), this.spatialTolerance = 0.05, this.autoDestroyDisabled = !1, this.arcgisTraceLocationSelectEnd = S(), this.arcgisTraceLocationSelectStart = S(), this.arcgisError = S();
@@ -73,7 +73,7 @@ class x extends N {
     e.has("filterLayers") && this.#o();
   }
   #e(e, t) {
-    this.error = t, d(e, this, t), this.arcgisError.emit();
+    this.error = t, u(e, this, t), this.arcgisError.emit();
   }
   #s(e) {
     const { traceLocations: t, view: r } = this;
@@ -101,24 +101,24 @@ class x extends N {
   #n(e, t) {
     const r = e.clone(), i = r.spatialReference, s = t.spatialReference;
     if (!i || !s)
-      return d("warn", this, "Unable to calculate percent along because geometry is missing a spatial reference."), -1;
+      return u("warn", this, "Unable to calculate percent along because geometry is missing a spatial reference."), -1;
     let a = t;
     if (!i.equals(s)) {
       const f = P(t, i);
       if (!f)
-        return d("warn", this, "Unable to project flag point to source geometry spatial reference."), -1;
+        return u("warn", this, "Unable to project flag point to source geometry spatial reference."), -1;
       a = f;
     }
     const n = _(r, a);
     if (n.isEmpty)
-      return d("warn", this, "Unable to compute nearest coordinate for polyline flag."), -1;
-    const o = n.coordinate, c = o.x - 0.5, l = o.y - 0.5, u = o.x + 0.5, m = o.y + 0.5, g = new A({
+      return u("warn", this, "Unable to compute nearest coordinate for polyline flag."), -1;
+    const o = n.coordinate, c = o.x - 0.5, l = o.y - 0.5, d = o.x + 0.5, m = o.y + 0.5, g = new A({
       hasZ: !1,
       hasM: !0,
       paths: [
         [
           [c, l],
-          [u, m]
+          [d, m]
         ]
       ],
       spatialReference: r.spatialReference
@@ -128,7 +128,7 @@ class x extends N {
       let y;
       return h[0].paths[0][0][0] === r.paths[0][0][0] ? y = w(h[0], { unit: "feet" }) : h.length > 1 ? y = w(h[1], { unit: "feet" }) : y = 0, y / f;
     }
-    return d("warn", this, "Unable to cut the source geometry with the flag geometry."), -1;
+    return u("warn", this, "Unable to cut the source geometry with the flag geometry."), -1;
   }
   get #c() {
     const e = this.utilityNetwork?.dataElement?.domainNetworks;
@@ -137,7 +137,7 @@ class x extends N {
   async #l() {
     const { view: e, sketchViewModel: t } = this;
     if (!(e && t)) {
-      d("error", this, "Cannot add trace location."), t || d("error", this, b("sketchViewModel")), e || d("error", this, b("view"));
+      u("error", this, "Cannot add trace location."), t || u("error", this, b("sketchViewModel")), e || u("error", this, b("view"));
       return;
     }
     if (this.beforeTraceLocationSelectStart) {
@@ -151,19 +151,19 @@ class x extends N {
     await this.#t(e, t);
   }
   async #t(e, t) {
-    this.arcgisTraceLocationSelectStart.emit({ cancelSelect: () => t.cancel() }).defaultPrevented || (this.#r?.remove(), this.#r = t.on("create", (i) => this.#d(i, e, t)), "acquireCursor" in e && e.acquireCursor("crosshair"), t.snappingOptions.enabled = !0, t.create("point"));
+    this.arcgisTraceLocationSelectStart.emit({ cancelSelect: () => t.cancel() }).defaultPrevented || (this.#r?.remove(), this.#r = t.on("create", (i) => this.#u(i, e, t)), "acquireCursor" in e && e.acquireCursor("crosshair"), t.snappingOptions.enabled = !0, t.create("point"));
   }
-  #d(e, t, r) {
+  #u(e, t, r) {
     if (e.state === "complete" && e.graphic) {
-      r.layer.remove(e.graphic), this.#u(e, t, r);
+      r.layer.remove(e.graphic), this.#d(e, t, r);
       return;
     }
     e.state === "cancel" && (this.#i(), this.arcgisTraceLocationSelectEnd.emit());
   }
-  async #u(e, t, r) {
+  async #d(e, t, r) {
     const { utilityNetwork: i } = this, { graphic: s } = e;
     if (!i) {
-      d("error", this, b("utilityNetwork")), this.#i(), this.arcgisTraceLocationSelectEnd.emit();
+      u("error", this, b("utilityNetwork")), this.#i(), this.arcgisTraceLocationSelectEnd.emit();
       return;
     }
     if (s?.geometry?.type !== "point") {
@@ -177,7 +177,7 @@ class x extends N {
     }
     const c = (await t.hitTest(n, {
       include: this.filterLayers
-    })).results.filter((u) => u.type === "graphic" && u?.layer && u.graphic);
+    })).results.filter((d) => d.type === "graphic" && d?.layer && d.graphic);
     if (!c.length) {
       this.#e("info", this._messages.errors.noHitResult), this.#t(t, r);
       return;
@@ -187,7 +187,7 @@ class x extends N {
   #i() {
     const { view: e, sketchViewModel: t } = this;
     if (!e) {
-      d("error", this, b("view"));
+      u("error", this, b("view"));
       return;
     }
     t && (t.snappingOptions.enabled = !1), this.#r?.remove(), this.#r = void 0, "acquireCursor" in e && e.acquireCursor("default");
@@ -208,13 +208,13 @@ class x extends N {
       }
     }
     if (!s)
-      return d("error", this, "No graphic available from hit test results."), this.arcgisTraceLocationSelectEnd.emit(), !0;
+      return u("error", this, "No graphic available from hit test results."), this.arcgisTraceLocationSelectEnd.emit(), !0;
     const a = await this.#h(s);
     return a ? await this.#m(a, t, r) : (this.#e("error", this._messages.errors.missingAttributes), this.arcgisTraceLocationSelectEnd.emit(), !0);
   }
   async #h(e) {
-    const t = (G(e.layer), e.layer), r = t.geometryType === null, i = t.fieldsIndex?.get("assetgroup") ?? !1, s = t.fieldsIndex?.get("assetgroup")?.name ?? "assetgroup", a = t.fieldsIndex?.get("assettype") ?? !1, n = t.fieldsIndex?.get("assettype")?.name ?? "assettype", o = e.getGlobalId(), c = e.getObjectId(), l = i ? !!e.getAttribute(s) : !0, u = a ? !!e.getAttribute(n) : !0, m = !!e.geometry;
-    if (o && c && l && u && (m || r))
+    const t = (G(e.layer), e.layer), r = t.geometryType === null, i = t.fieldsIndex?.get("assetgroup") ?? !1, s = t.fieldsIndex?.get("assetgroup")?.name ?? "assetgroup", a = t.fieldsIndex?.get("assettype") ?? !1, n = t.fieldsIndex?.get("assettype")?.name ?? "assettype", o = e.getGlobalId(), c = e.getObjectId(), l = i ? !!e.getAttribute(s) : !0, d = a ? !!e.getAttribute(n) : !0, m = !!e.geometry;
+    if (o && c && l && d && (m || r))
       return e;
     const g = t.createQuery();
     return g.objectIds = [c], (await t.queryFeatures(g)).features[0] || null;
@@ -257,7 +257,7 @@ class x extends N {
       };
     } else if (a === "polyline") {
       const o = this.#n(e.geometry, t);
-      return o < 0 ? (d("warn", this, "Unable to calculate percent along for polyline flag."), null) : {
+      return o < 0 ? (u("warn", this, "Unable to calculate percent along for polyline flag."), null) : {
         traceLocation: new T({
           type: r,
           isFilterBarrier: !1,
@@ -276,20 +276,20 @@ class x extends N {
         }
       };
     } else if (!a) {
-      const o = H(e.layer) ? e.layer.parent : e.layer, c = o && this.#c.includes(o.layerId), l = i?.getTerminalConfiguration(e), u = l ? l.terminals[0].id : c ? -1 : 1, m = c ? 0.5 : -1;
+      const o = H(e.layer) ? e.layer.parent : e.layer, c = o && this.#c.includes(o.layerId), l = i?.getTerminalConfiguration(e), d = l ? l.terminals[0].id : c ? -1 : 1, m = c ? 0.5 : -1;
       return {
         traceLocation: new T({
           type: r,
           isFilterBarrier: !1,
           globalId: s,
-          terminalId: u,
+          terminalId: d,
           percentAlong: m
         }),
         flagProperties: {
           title: n,
           expanded: !1,
           terminalConfiguration: l ?? void 0,
-          selectedTerminals: l ? /* @__PURE__ */ new Set([u]) : void 0
+          selectedTerminals: l ? /* @__PURE__ */ new Set([d]) : void 0
         },
         spatialProperties: {
           mapPoint: t,
@@ -369,9 +369,9 @@ class x extends N {
   #x(e) {
     const { flagProperties: t } = e, { terminalConfiguration: r } = t;
     if (!r)
-      return d("warn", this, "One or more locations are missing the required flag property `terminalConfiguration`."), [];
+      return u("warn", this, "One or more locations are missing the required flag property `terminalConfiguration`."), [];
     const i = r.terminals;
-    return i.length ? i.length === 1 ? [] : i.map((a) => this.#w(e, a)) : (d("warn", this, "`terminalConfiguration.terminals` is required but either missing or empty.`"), []);
+    return i.length ? i.length === 1 ? [] : i.map((a) => this.#w(e, a)) : (u("warn", this, "`terminalConfiguration.terminals` is required but either missing or empty.`"), []);
   }
   #G(e) {
     const { flagProperties: t } = e, { terminalConfiguration: r, expanded: i, title: s } = t, a = r && r.id !== 0, n = e.traceLocation.type === "barrier", o = a || n, c = r?.name ?? void 0;

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

@@ -6,6 +6,7 @@ import type Layer from "@arcgis/core/layers/Layer.js";
 import type UtilityNetwork from "@arcgis/core/networks/UtilityNetwork.js";
 import type TraceResult from "@arcgis/core/rest/networks/support/TraceResult.js";
 import type MapView from "@arcgis/core/views/MapView.js";
+import type { ActionEvent } from "@arcgis/core/widgets/Popup/types.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisFeaturesNext } from "../arcgis-features-next/customElement.js";
 import type { ArcgisReferenceElement } from "../types.js";
@@ -23,20 +24,14 @@ export abstract class ArcgisUtilityNetworkTraceResults extends LitElement {
   protected _messages: {
       gettingResults: string;
       headings: {
+          aggregatedGeometry: string;
           features: string;
           functions: string;
-          setColor: string;
-          totalFeatures: string;
-          traceResultsCustom: string;
           traceResultsGeneric: string;
       };
       labels: {
-          aggregatedGeometryGraphicsColor: string;
           functionResults: string;
-          numElements: string;
           numFeatures: string;
-          numFunctions: string;
-          traceResultElementsByLayer: string;
       };
       noResultsDescription: string;
       noResultsHeading: string;
@@ -51,24 +46,17 @@ export abstract class ArcgisUtilityNetworkTraceResults extends LitElement {
       };
       traceFailedDescription: string;
       traceFailedHeading: string;
-      unknown: string;
   } & T9nMeta<{
       gettingResults: string;
       headings: {
+          aggregatedGeometry: string;
           features: string;
           functions: string;
-          setColor: string;
-          totalFeatures: string;
-          traceResultsCustom: string;
           traceResultsGeneric: string;
       };
       labels: {
-          aggregatedGeometryGraphicsColor: string;
           functionResults: string;
-          numElements: string;
           numFeatures: string;
-          numFunctions: string;
-          traceResultElementsByLayer: string;
       };
       noResultsDescription: string;
       noResultsHeading: string;
@@ -83,8 +71,17 @@ export abstract class ArcgisUtilityNetworkTraceResults extends LitElement {
       };
       traceFailedDescription: string;
       traceFailedHeading: string;
-      unknown: string;
   }>;
+  /**
+   * A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [action button](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggle](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) objects. Each action may be executed by clicking the icon or image symbolizing them.
+   * There is a default `Zoom To` action styled with a magnifying glass icon to zoom in four LODs and center the map on the selected feature. This default action can be removed by setting [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#includeDefaultActionsDisabled) to `true`, or by setting the [`overwriteActions`](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).
+   *
+   * The order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/). The [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#event-arcgisTriggerAction) event fires each time an action is clicked.
+   *
+   * @see [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#event-arcgisTriggerAction)
+   * @see [Popup actions sample](https://developers.arcgis.com/javascript/latest/sample-code/popup-actions/)
+   */
+  accessor actions: ArcgisFeaturesNext["actions"] | undefined;
   accessor aggregatedGeometryGraphicsColor: Color;
   /**
    * If true, the component will not be destroyed automatically when it is
@@ -105,6 +102,14 @@ export abstract class ArcgisUtilityNetworkTraceResults extends LitElement {
    * 
    */
   accessor autoDestroyDisabled: boolean;
+  /**
+   * Whether to disable highlighting trace result features on the map.
+   * If true, the features returned by a trace will not be highlighted on the map.
+   *
+   * @default false
+   */
+  accessor disableHighlightFeatureResults: boolean;
+  accessor heading: string | undefined;
   /**
    * @default false
    * @internal
@@ -112,31 +117,47 @@ export abstract class ArcgisUtilityNetworkTraceResults extends LitElement {
   accessor hideActionBar: boolean;
   /** @default false */
   accessor hideFeatureResults: boolean;
-  /** @default false */
-  accessor isElementsSelected: boolean;
+  /**
+   * Whether to hide the aggregated geometry [graphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics)
+   * from the map when the trace result contains aggregated geometry results.
+   *
+   * @default false
+   */
+  accessor hideGraphics: boolean;
+  /**
+   * Whether to hide the placeholder string when feature results are hidden.
+   *
+   * When this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#hideFeatureResults) are both set to `true`,
+   * nothing is rendered for trace result elements. However, features are still queried and are available through
+   * [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResultFeatures).
+   *
+   * @default false
+   */
+  accessor hidePlaceholder: boolean;
+  /**
+   * Indicates whether default actions are disabled (hidden) when viewing trace result features.
+   * This property must be set to `true` to disable default actions.
+   *
+   * @default false
+   */
+  accessor includeDefaultActionsDisabled: boolean;
   accessor layers: Layer[];
   /**
    * Replace localized message strings with your own strings.
    *
    * _**Note**: Individual message keys may change between releases._
    */
-  accessor messageOverrides: NonNullable<ArcgisFeaturesNext["messageOverrides"]> & {
+  accessor messageOverrides: {
       gettingResults?: string | undefined;
       headings?: {
+          aggregatedGeometry?: string | undefined;
           features?: string | undefined;
           functions?: string | undefined;
-          setColor?: string | undefined;
-          totalFeatures?: string | undefined;
-          traceResultsCustom?: string | undefined;
           traceResultsGeneric?: string | undefined;
       } | undefined;
       labels?: {
-          aggregatedGeometryGraphicsColor?: string | undefined;
           functionResults?: string | undefined;
-          numElements?: string | undefined;
           numFeatures?: string | undefined;
-          numFunctions?: string | undefined;
-          traceResultElementsByLayer?: string | undefined;
       } | undefined;
       noResultsDescription?: string | undefined;
       noResultsHeading?: string | undefined;
@@ -151,39 +172,44 @@ export abstract class ArcgisUtilityNetworkTraceResults extends LitElement {
       } | undefined;
       traceFailedDescription?: string | undefined;
       traceFailedHeading?: string | undefined;
-      unknown?: string | undefined;
   };
-  get numResults(): number;
+  /**
+   * The number of unique network element results,
+   * including elements that did not match any layer in the map.
+   *
+   * TODO: We can remove this after we allow the result items to be rendered declaratively
+   *  as children of the trace results component.
+   */
+  get numFeatureResults(): number;
   /**
    * 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;
-  /** @default "ready" */
+  /** @default "loading" */
   accessor state: State;
-  accessor traceConfigTitle: string | undefined;
   accessor traceError: EsriError<TraceErrorDetails> | undefined;
   accessor traceResult: TraceResult | undefined;
-  accessor traceResultFeatures: Graphic[];
+  get traceResultFeatures(): Graphic[];
   accessor utilityNetwork: UtilityNetwork | undefined;
   /**
    * 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-results component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapView | undefined;
-  clearAggregatedGeometryGraphics(): void;
+  clearResults(): void;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
-  readonly arcgisAggregatedGeometryGraphicsColorChange: import("@arcgis/lumina").TargetedEvent<this, string>;
-  readonly arcgisHideGraphicsChange: import("@arcgis/lumina").TargetedEvent<this, boolean>;
-  readonly arcgisSelectedResultTypeChange: import("@arcgis/lumina").TargetedEvent<this, 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: "aggregatedGeometryGraphicsColor" | "hideGraphics" | "state" | "traceError"; }>;
   readonly arcgisTraceResultFeaturesReady: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** Emitted when an action is triggered on the component. */
+  readonly arcgisTriggerAction: import("@arcgis/lumina").TargetedEvent<this, ActionEvent>;
   readonly "@eventTypes": {
-    arcgisAggregatedGeometryGraphicsColorChange: ArcgisUtilityNetworkTraceResults["arcgisAggregatedGeometryGraphicsColorChange"]["detail"];
-    arcgisHideGraphicsChange: ArcgisUtilityNetworkTraceResults["arcgisHideGraphicsChange"]["detail"];
-    arcgisSelectedResultTypeChange: ArcgisUtilityNetworkTraceResults["arcgisSelectedResultTypeChange"]["detail"];
+    arcgisPropertyChange: ArcgisUtilityNetworkTraceResults["arcgisPropertyChange"]["detail"];
     arcgisTraceResultFeaturesReady: ArcgisUtilityNetworkTraceResults["arcgisTraceResultFeaturesReady"]["detail"];
+    arcgisTriggerAction: ArcgisUtilityNetworkTraceResults["arcgisTriggerAction"]["detail"];
   };
 }