@arcgis/map-components 4.33.0-next.16 → 4.33.0-next.160

package/dist/chunks/useWidget.js

@@ -1,118 +1,113 @@
-import { proxyExports as w, watch as r, trackPropKey as f } from "@arcgis/components-controllers";
-import { AccessorController as p, accessorSupport as a } from "@arcgis/components-controllers/accessor";
-import { a as l } from "./component-utils.js";
+import { proxyExports as v, getControllersCount as w, trackPropKey as y } from "@arcgis/lumina/controllers";
+import { AccessorController as b, getAccessorControllerBoundProperties as E, makeBinderProxy as x } from "@arcgis/lumina/controllers/accessor";
+import { isEsriInternalEnv as M } from "@arcgis/components-utils";
+import { V as g } from "./useView.js";
+import { watch as m } from "@arcgis/core/core/reactiveUtils.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.16 */
-const P = (d, s) => (i, e) => _(i, d, e);
-class y extends p {
-  constructor(s, i, e) {
-    super(s, i, e), this._watchedViewModelProperties = /* @__PURE__ */ new Map(), this._watchedVisibleElementsProperties = {}, this._isBindingViewModel = { value: !0 }, Object.defineProperty(this.exports, "viewModel", {
-      value: a.makeGetterProxy(s, this._watchedViewModelProperties, this._isBindingViewModel)
-    }), Object.defineProperty(this.exports, "visibleElements", {
-      value: this._makeVisibleElementsBinder()
+v4.33.0-next.160 */
+const I = (d, e) => (t) => P(t, d);
+class f extends b {
+  #o = /* @__PURE__ */ new Map();
+  #e;
+  #t;
+  constructor(e, t) {
+    super(e, t), new g(e);
+    const s = this, o = s.instance;
+    let n = o.viewModel, l = o.visibleElements;
+    const r = new Proxy(this.exports, {
+      get(i, a, h) {
+        return a === "viewModel" ? n : a === "visibleElements" ? l : Reflect.get(i, a, h);
+      }
     });
+    if (s.#t = o, s.instance = r, s.exports = r, n) {
+      const i = {
+        component: e,
+        get exports() {
+          return s.instance.viewModel;
+        }
+      };
+      E(s).set("viewModel", "viewModel"), e.addController(i), n = x(e, new WeakRef(i), w(e) - 1, n, s.#o);
+    }
+    s.instance.visibleElements && (l = s.#s(o));
   }
   hostConnected() {
-    super.hostConnected(), this._isBindingViewModel.value = !1, this.component.manager.loadedCalled && l(this.component);
+    this.instance = this.#t, super.hostConnected();
   }
-  async hostLoad() {
-    if (this._watchedProperties.delete("viewModel"), await super.hostLoad(), this.component.manager.destroyed)
-      return;
-    this._watchMetaProperties(), this.onLifecycle(() => this.reactiveUtils.watch(() => this._instance.viewModel, (e) => {
-      this.component.viewModel = e;
-    }, { initial: !0 }));
-    const s = this._instance.viewModel;
-    typeof s == "object" && (a.watchComponentUpdates(this, s, this._watchedViewModelProperties), a.watchAccessorUpdates(this, s, this._watchedViewModelProperties));
-    const i = Object.entries(this._watchedVisibleElementsProperties);
-    i.length > 0 && this.onLifecycle(() => i.map(([e, t]) => {
-      let n = this._instance.visibleElements ?? {}, o;
-      for (const c of t.slice(0, -1))
-        if (typeof n[c] == "object" && n[c] !== null)
-          n = n[c];
-        else {
-          o = !!n[c];
-          break;
-        }
-      o === void 0 && (o = !!(n[t.slice(-1)[0]] ?? !0)), e.startsWith("hide");
-      const m = e.startsWith("hide") || e.startsWith("show") ? e.startsWith("hide") : o, h = this.component;
-      return typeof h[e] == "boolean" ? this._updateWidgetVisibleElement(t, h[e], m) : h[e] = !1, r(this.component, e, (c) => this._updateWidgetVisibleElement(t, c, m));
-    }));
+  hostLoad() {
+    this.#e = m(() => this.component.el.view, (e) => {
+      const t = this.instance;
+      !("view" in t) && typeof t.viewModel == "object" ? t.viewModel.view = e : t.view = e, !("map" in t) && typeof t.viewModel == "object" ? t.viewModel.map = e?.map : t.map = e?.map;
+    }, { sync: !0, initial: !0 });
   }
-  _updateWidgetVisibleElement(s, i, e) {
-    let t = this._instance.visibleElements ?? {};
-    for (const o of s.slice(0, -1))
-      (typeof t[o] != "object" || t[o] === null) && (t[o] = {}), t = t[o];
-    const n = !!(e ? !i : i);
-    t[s.at(-1)] = n;
+  hostUpdate(e) {
+    e.has("closed") && (this.instance.visible = !this.component.closed);
   }
   hostLoaded() {
-    const { el: s } = this.component;
-    s.childElem ??= document.createElement("div"), this._instance.container = s.childElem;
-    let i = !1;
-    const e = this.component.el.view;
-    Object.defineProperty(this.component.el, "view", {
-      get: () => this._instance.view ?? this._instance.viewModel?.view,
-      set: (t) => {
-        !("view" in this._instance) && typeof this._instance.viewModel == "object" ? this._instance.viewModel.view = t : this._instance.view = t, !("map" in this._instance) && typeof this._instance.viewModel == "object" ? this._instance.viewModel.map = t.map : this._instance.map = t.map, this._watchViewDestroy(), t && !i && (i = !0, this.component.arcgisReady.emit());
-      },
-      configurable: !0,
-      enumerable: !0
-    }), e && (this._instance.view = e), this.component.el.isConnected && (l(this.component), this._watchViewDestroy());
+    const { el: e } = this.component;
+    e.childElem ??= document.createElement("div"), this.instance.container = e.childElem, this.component.closed !== void 0 && this.onLifecycle(() => m(() => this.instance.visible, (t) => this.component.closed = !t, { initial: !0 }));
   }
-  hostDisconnected() {
-    typeof this.component.el.childElem == "object" && this.component.el.view?.ui?.remove(this.component.el.childElem);
-  }
-  hostDestroy() {
-    super.hostDestroy(), this._watchViewDestroyHandle?.remove();
-  }
-  _watchMetaProperties() {
-    r(this.component, "position", (s) => {
-      this.component.el.childElem != null && typeof s == "string" && l(this.component);
-    }), r(this.component, "referenceElement", () => l(this.component));
-  }
-  _makeVisibleElementsBinder() {
-    return new Proxy({}, {
-      has: (s, i) => typeof i == "string" || Reflect.has(s, i),
-      get: (s, i) => {
-        if (typeof i == "symbol" || i in Promise.prototype)
-          return Reflect.get(s, i);
-        const e = [i], t = this._makeRecursiveProxy(e);
-        return f(this.component, (n) => {
-          const o = n;
-          this.component[o] = !1, this._watchedVisibleElementsProperties[o] = e;
-        }, t);
+  #s(e) {
+    return new Proxy(e.visibleElements, {
+      get: (t, s) => {
+        if (typeof s == "symbol" || s in Promise.prototype)
+          return t[s];
+        const o = [s], n = this.#i(o);
+        return y(this.component, (l) => {
+          const r = l;
+          this.component[r] = !1;
+          let i = e.visibleElements ?? {}, a;
+          for (const c of o.slice(0, -1))
+            if (typeof i[c] == "object" && i[c] !== null)
+              i = i[c];
+            else {
+              a = !!i[c];
+              break;
+            }
+          a === void 0 && (a = !!(i[o.slice(-1)[0]] ?? !0));
+          const p = r.startsWith("hide") || r.startsWith("show") ? r.startsWith("hide") : a;
+          this.onUpdate((c) => {
+            if (c.has(r)) {
+              const u = this.component[r];
+              this.#n(o, u, p);
+            }
+          });
+        }, n);
       }
     });
   }
-  _makeRecursiveProxy(s) {
-    const i = new Proxy({}, {
-      get: (e, t) => {
-        const n = Reflect.get(e, t);
-        return typeof t == "symbol" || t in Promise.prototype ? n : (s.push(t), i);
+  #i(e) {
+    const t = new Proxy({}, {
+      get: (s, o) => {
+        const n = Reflect.get(s, o);
+        return typeof o == "symbol" || o in Promise.prototype ? n : (e.push(o), t);
       }
     });
-    return i;
+    return t;
   }
-  /**
-   * Destroy the component if view gets destroyed.
-   *
-   * When view is destroyed, component disconnect is triggered, which will
-   * destroy the component in 1s but that can be too late, because in the
-   * meanwhile, a watcher on the widget/viewModel instance may get triggered,
-   * and throw an error if it's not able to access this.view.map or etc
-   * (happens in VersionManagementViewModel for example).
-   *
-   * We can't check for this in disconnectedCallback though as, if the entire
-   * component tree is removed, the disconnect for the component will be
-   * triggered before that of arcgis-map, so the view might not be destroyed
-   * yet at that point.
-   */
-  _watchViewDestroy() {
-    this._watchViewDestroyHandle?.remove(), this._watchViewDestroyHandle = this.reactiveUtils.when(() => this.component.el.view?.destroyed === !0, () => void this.component.destroy().catch(console.error), { sync: !0 });
+  #n(e, t, s) {
+    let o = this.instance.visibleElements ?? {};
+    for (const l of e.slice(0, -1))
+      (typeof o[l] != "object" || o[l] === null) && (o[l] = {}), o = o[l];
+    const n = !!(s ? !t : t);
+    o[e.at(-1)] = n;
+  }
+  hostDestroy() {
+    this.#e?.remove(), super.hostDestroy();
   }
 }
-const _ = w(y);
+process.env.NODE_ENV !== "production" && M() && (f.devOnly$allowedPropNameMismatches = /* @__PURE__ */ new Set([
+  "manager",
+  "el",
+  "position",
+  "multipleSortEnabled",
+  // Deprecated
+  "focusTrapEnabled",
+  "focusTrapDisabled",
+  // Deprecated
+  "hideLastEditInfo"
+]));
+const P = v(f);
 export {
-  P as m
+  I as m
 };

package/dist/chunks/utils.js

@@ -0,0 +1,58 @@
+import { formatNumber as r } from "@arcgis/core/intl.js";
+/*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
+See https://js.arcgis.com/4.33/esri/copyright.txt for details.
+v4.33.0-next.160 */
+const s = /* @__PURE__ */ new Map([
+  ["a3-landscape", "a3-landscape"],
+  ["a3-portrait", "a3-portrait"],
+  ["a4-landscape", "a4-landscape"],
+  ["a4-portrait", "a4-portrait"],
+  ["letter-ansi-a-landscape", "ansi-a-landscape"],
+  ["letter-ansi-a-portrait", "ansi-a-portrait"],
+  ["tabloid-ansi-b-landscape", "ansi-b-landscape"],
+  ["tabloid-ansi-b-portrait", "ansi-b-portrait"]
+]), u = /^https:\/\/([a-z\d-]+)(\.maps([^.]*))?\.arcgis\.com/iu;
+function d(a) {
+  const t = a?.closest("[dir]");
+  return t !== null && t instanceof HTMLElement && t.dir === "rtl" || document.dir === "rtl";
+}
+function f(a) {
+  if (!a)
+    return;
+  const t = a.layoutTemplateInfo;
+  if (!t)
+    return;
+  const [e, n] = t.pageSize;
+  return `${r(e)} × ${r(n)} ${a.pageUnits}`;
+}
+function m(a, t) {
+  const { label: e, layout: n, layoutItem: o, type: i } = a;
+  return i === "print-service-template" && t[n] ? t[n] : (e ?? n ?? o?.id)?.replaceAll("_", " ") ?? t.untitled;
+}
+function g(a) {
+  return s.get(a);
+}
+const b = /* @__PURE__ */ new Map([
+  ["AIX", "aix"],
+  ["EPS", "eps"],
+  ["GIF", "gif"],
+  ["JPG", "jpg"],
+  ["PDF", "pdf"],
+  ["PNG32", "png32"],
+  ["PNG8", "png8"],
+  ["SVG", "svg"],
+  ["SVGZ", "svgz"],
+  ["TIFF", "tiff"]
+]), l = "map-only";
+function L(a) {
+  return a?.toLowerCase() === l;
+}
+export {
+  m as a,
+  g as b,
+  d as c,
+  b as f,
+  f as g,
+  L as i,
+  u as r
+};

package/dist/components/arcgis-area-measurement-2d/customElement.d.ts

@@ -1,73 +1,109 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
-import { Nil } from '@arcgis/components-utils';
+import { Use } from '@arcgis/lumina/controllers';
 import { default as AreaMeasurement2D } from '@arcgis/core/widgets/AreaMeasurement2D.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useAreaMeasurement2dWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<AreaMeasurement2D & {
+declare const useAreaMeasurement2dWidget: (component: LitElement & Pick<AreaMeasurement2D & {
     viewModel: __esri.Accessor;
-}, "label" | "viewModel" | "icon" | "snappingOptions" | "unit" | "unitOptions"> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+}, "icon" | "label" | "viewModel" | "snappingOptions" | "unit" | "unitOptions"> & {
     state?: unknown;
     viewModel?: (__esri.AreaMeasurement2DViewModel & __esri.Accessor) | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    closed?: boolean;
+    icon: import('@arcgis/components-utils').Nil | string;
+    label: import('@arcgis/components-utils').Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
     position: __esri.UIPosition;
-    arcgisReady: import('@arcgis/components-controllers').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
+    arcgisReady: import('@arcgis/lumina').EventEmitter;
+    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
         name: string;
     }> | undefined;
     el: HTMLElement & {
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.AreaMeasurement2DProperties): __esri.AreaMeasurement2DProperties | Promise<__esri.AreaMeasurement2DProperties>;
-} | undefined) => AreaMeasurement2D & {
+}) => AreaMeasurement2D & {
     viewModel: __esri.Accessor;
 };
-/** AreaMeasurement2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+/**
+ * The Area Measurement 2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/)
  */
 export declare class ArcgisAreaMeasurement2d extends LitElement {
     /**
      * If true, the component will not be destroyed automatically when it is
      * disconnected from the document. This is useful when you want to move the
      * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the \`destroy\` method when you are done to prevent
-     * memory leaks.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
     /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     * Icon which represents the widget.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "measure-area"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#label)
+     */
     label: string;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * 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)
+     */
+    referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#snappingOptions)
+     */
     snappingOptions: __esri.SnappingOptions;
+    /**
+     * The ViewModel's state.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state)
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "disabled" | "measuring" | "measured";
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the area values.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)
+     */
     unit: __esri.SystemOrAreaUnit;
+    /**
+     * List of available units and unit systems (imperial, metric) for displaying the area values.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)
+     */
     unitOptions: __esri.SystemOrAreaUnit[];
-    /** Permanently destroy the component */
+    /** Clear the current measurement. */
+    clear(): Promise<void>;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
+    /** Starts a new measurement. */
+    start(): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
 }
 export {};

package/dist/components/arcgis-area-measurement-2d/customElement.js

@@ -1,37 +1,40 @@
 import { c as t } from "../../chunks/runtime.js";
-import { usePropertyChange as e } from "@arcgis/components-controllers";
+import { usePropertyChange as e } from "@arcgis/lumina/controllers";
 import s from "@arcgis/core/widgets/AreaMeasurement2D.js";
-import { LitElement as i, createEvent as o, noShadowRoot as a } from "@arcgis/lumina";
+import { LitElement as i, createEvent as a, noShadowRoot as o } from "@arcgis/lumina";
 import { m as r } from "../../chunks/useWidget.js";
 import { css as n } from "@lit/reactive-element/css-tag.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.16 */
-const h = n`@layer{arcgis-area-measurement-2d{display:block}}`, m = r(
+v4.33.0-next.160 */
+const h = n`@layer{arcgis-area-measurement-2d{display:block}}`, l = r(
   // Workaround for https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/61559
   s
 );
-class p extends i {
+class m extends i {
   constructor() {
-    super(...arguments), this.widget = m(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.icon = this.widget.icon, this.label = this.widget.label, this.position = "bottom-left", this.snappingOptions = this.widget.snappingOptions, this.state = this.viewModel.state, this.unit = this.widget.unit, this.unitOptions = this.widget.unitOptions, this.arcgisPropertyChange = e()("state"), this.arcgisReady = o();
+    super(...arguments), this.widget = l(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.icon = this.widget.icon, this.label = this.widget.label, this.position = "bottom-left", this.snappingOptions = this.widget.snappingOptions, this.state = this.viewModel.state, this.unit = this.widget.unit, this.unitOptions = this.widget.unitOptions, this.arcgisPropertyChange = e()("state"), this.arcgisReady = a();
   }
   static {
     this.properties = { autoDestroyDisabled: 5, icon: 1, label: 1, position: 1, referenceElement: 1, snappingOptions: 0, state: 3, unit: 1, unitOptions: 0 };
   }
   static {
-    this.shadowRootOptions = a;
+    this.shadowRootOptions = o;
   }
   static {
     this.styles = h;
   }
-  // #endregion
-  // #region Public Methods
-  /** Permanently destroy the component */
+  async clear() {
+    this.viewModel?.clear();
+  }
   async destroy() {
     await this.manager.destroy();
   }
+  async start() {
+    this.viewModel?.start();
+  }
 }
-t("arcgis-area-measurement-2d", p);
+t("arcgis-area-measurement-2d", m);
 export {
-  p as ArcgisAreaMeasurement2d
+  m as ArcgisAreaMeasurement2d
 };

package/dist/components/arcgis-area-measurement-3d/AreaMeasurement3dViewModel.d.ts

@@ -0,0 +1,39 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import { default as AreaMeasurementAnalysis } from '@arcgis/core/analysis/AreaMeasurementAnalysis.js';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { AnalysisViewModel } from '../../support/AnalysisViewModel';
+import { MeasurementModeString, MeasurementState, MeasurementValue } from '../../support/measurementUtils';
+export interface Measurement {
+    readonly mode: MeasurementModeString;
+    readonly area: MeasurementValue<__esri.Area>;
+    readonly perimeter: MeasurementValue<__esri.Length>;
+}
+export default class AreaMeasurement3dViewModel extends AnalysisViewModel<SceneView, AreaMeasurementAnalysis> {
+    initialize(): void;
+    get state(): Exclude<MeasurementState, "unsupported">;
+    get displayState(): MeasurementState;
+    /**
+     * The current measurement calculated between the two points.
+     */
+    get measurement(): Measurement;
+    /**
+     * List of unit systems (imperial, metric) and specific units for displaying the distance values.
+     */
+    get unitOptions(): __esri.SystemOrAreaUnit[];
+    set unitOptions(units: __esri.SystemOrAreaUnit[] | undefined);
+    private _userUnitOptions?;
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the distance values.
+     */
+    get unit(): __esri.SystemOrAreaUnit;
+    set unit(unit: __esri.SystemOrAreaUnit | undefined);
+    private _userUnit?;
+    get defaultUnit(): __esri.MeasurementSystem | undefined;
+    place(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    protected clearAnalysis(): void;
+    protected readonly supportedViewType = "3d";
+    protected readonly unsupportedErrorMessage = "The Area Measurement 3D component is only supported in 3D views.";
+    protected constructAnalysis(): AreaMeasurementAnalysis;
+}

package/dist/components/arcgis-area-measurement-3d/customElement.d.ts

@@ -1,71 +1,64 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
-import { Nil } from '@arcgis/components-utils';
-import { default as AreaMeasurement3D } from '@arcgis/core/widgets/AreaMeasurement3D.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { PublicLitElement as LitElement, JsxNode, TargetedEvent } from '@arcgis/lumina';
+import { Use } from '@arcgis/lumina/controllers';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { default as AreaMeasurement3dViewModel } from './AreaMeasurement3dViewModel';
 
-declare const useAreaMeasurement3dWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<AreaMeasurement3D, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
-    state?: unknown;
-    viewModel?: __esri.AreaMeasurement3DViewModel | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    position: __esri.UIPosition;
-    arcgisReady: import('@arcgis/components-controllers').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.MapView | __esri.SceneView | Nil;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.AreaMeasurement3DProperties | undefined): __esri.AreaMeasurement3DProperties | Promise<__esri.AreaMeasurement3DProperties | undefined> | undefined;
-} | undefined) => AreaMeasurement3D;
-/** AreaMeasurement3D component calculates and displays the area and perimeter of a polygon. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the area and perimeter of a polygon.
+declare const useViewModel: (component: LitElement & Pick<AreaMeasurement3dViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<AreaMeasurement3dViewModel>) => AreaMeasurement3dViewModel;
+/**
+ * The Area Measurement 3D component calculates and displays the area and perimeter of a polygon.
+ * This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)
+ * to measure the area and perimeter of a polygon.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/)
  */
 export declare class ArcgisAreaMeasurement3d extends LitElement {
-    readonly analysis: __esri.AreaMeasurementAnalysis;
+    /** Analysis data object. */
+    analysis: __esri.AreaMeasurementAnalysis;
     /**
      * If true, the component will not be destroyed automatically when it is
      * disconnected from the document. This is useful when you want to move the
      * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the \`destroy\` method when you are done to prevent
-     * memory leaks.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "measure-area"
      */
-    icon: string;
+    icon?: HTMLCalciteIconElement["icon"];
     /** The component's default label. */
-    label: string;
+    label?: string;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * 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)
+     */
+    referenceElement?: ArcgisReferenceElement | string;
+    /** The current state of the component. */
     readonly state: "ready" | "disabled" | "measuring" | "measured";
+    /** Unit system (imperial, metric) or specific unit used for displaying the distance values. */
     unit: __esri.SystemOrAreaUnit;
+    /** List of unit systems (imperial, metric) and specific units for displaying the distance values. */
     unitOptions: __esri.SystemOrAreaUnit[];
     clear(): Promise<void>;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     start(): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state" | "analysis";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
 }
 export {};