@arcgis/map-components 4.33.0-next.110 → 4.33.0-next.112

package/dist/components/arcgis-measurement/customElement.js

@@ -6,7 +6,7 @@ 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.110 */
+v4.33.0-next.112 */
 const c = n`@layer{arcgis-measurement{display:block}}`, l = r(i);
 class h extends s {
   constructor() {
@@ -21,12 +21,9 @@ class h extends s {
   static {
     this.styles = c;
   }
-  //#endregion
-  //#region Public Methods
   async clear() {
     this.widget?.clear();
   }
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }

package/dist/components/arcgis-navigation-toggle/customElement.d.ts

@@ -18,6 +18,8 @@ type LayoutMode = "horizontal" | "vertical";
  * right-click + drag pans the view.
  *
  * The Navigation Toggle component is only supported in 3D.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/)
  */
 export declare class ArcgisNavigationToggle extends LitElement {
     /**
@@ -30,7 +32,11 @@ export declare class ArcgisNavigationToggle extends LitElement {
     icon: HTMLCalciteIconElement["icon"] | Nil;
     /** The component's default label. */
     label: string | undefined;
-    /** The layout direction of the component. */
+    /**
+     * The layout direction of the component.
+     *
+     * @default "vertical"
+     */
     layout: LayoutMode;
     /**
      * The navigation mode of the view. See the table below for a list of
@@ -40,15 +46,25 @@ export declare class ArcgisNavigationToggle extends LitElement {
      * ---------------|-------------
      * pan | The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.
      * rotate | The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.
+     *
+     * @default "pan"
      */
     navigationMode: NavigationMode;
+    /** @default "top-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * The current state of the component.
+     *
+     * @default "disabled"
+     */
     state: State;
     toggle(): 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" | "layout";
     }>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, undefined>;
 }
 export {};

package/dist/components/arcgis-navigation-toggle/customElement.js

@@ -3,22 +3,21 @@ import { usePropertyChange as d } from "@arcgis/lumina/controllers";
 import { when as c } from "@arcgis/core/core/reactiveUtils.js";
 import { LitElement as g, createEvent as h, noShadowRoot as m, safeClassMap as v, nothing as r } from "@arcgis/lumina";
 import { html as u } from "lit";
-import { u as y } from "../../chunks/useT9n.js";
-import { u as f } from "../../chunks/useView.js";
-import { g as b } from "../../chunks/globalCss.js";
+import { a as y, u as b } from "../../chunks/useView.js";
+import { g as f } from "../../chunks/globalCss.js";
 import { css as M } 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.110 */
+v4.33.0-next.112 */
 const $ = "arcgis-navigation-toggle", w = {
   base: $
 }, x = M`@layer{.arcgis-navigation-toggle{display:flex;box-shadow:0 1px 2px #0000004d;inline-size:fit-content;block-size:fit-content}}`, e = { pan: "move", rotate: "rotate" };
 class _ extends g {
   constructor() {
-    super(...arguments), this.view = f(this), this._messages = y(), this.icon = e.pan, this.layout = "vertical", this.navigationMode = "pan", this.position = "top-left", this.state = "disabled", this.arcgisPropertyChange = d()("layout", "state"), this.arcgisReady = h();
+    super(...arguments), this.view = y(this), this._messages = b(), this.icon = e.pan, this.layout = "vertical", this.navigationMode = "pan", this.position = "top-left", this.state = "disabled", this.arcgisPropertyChange = d()("layout", "state"), this.arcgisReady = h();
   }
   static {
-    this.properties = { icon: 3, label: 1, layout: 3, navigationMode: 3, position: 1, referenceElement: 1, state: 3 };
+    this.properties = { icon: 1, label: 1, layout: 3, navigationMode: 3, position: 1, referenceElement: 1, state: 3 };
   }
   static {
     this.shadowRootOptions = m;
@@ -26,13 +25,9 @@ class _ extends g {
   static {
     this.styles = x;
   }
-  //#endregion
-  //#region Public Methods
   async toggle() {
     this.state !== "disabled" && (this.navigationMode = this.navigationMode !== "pan" ? "pan" : "rotate");
   }
-  //#endregion
-  //#region Lifecycle
   load() {
     this.manager.onLifecycle(() => [
       c(() => this.view?.navigation?.actionMap, () => this._updateNavigationActionMap()),
@@ -47,8 +42,6 @@ class _ extends g {
   willUpdate(t) {
     t.has("navigationMode") && this._updateNavigationActionMap();
   }
-  //#endregion
-  //#region Private Methods
   _onPanClick() {
     this.navigationMode = "pan";
   }
@@ -62,11 +55,9 @@ class _ extends g {
     const a = this.navigationMode === "pan";
     t.dragPrimary = a ? "pan" : "rotate", t.dragSecondary = a ? "rotate" : "pan";
   }
-  //#endregion
-  //#region Rendering
   render() {
-    const { _messages: t, navigationMode: a, state: l } = this, o = t.pan ?? "", s = t.rotate ?? "", i = l === "disabled", n = a === "pan";
-    return u`<calcite-action-bar class=${v({ [w.base]: !0, [b.disabled]: i })} expand-disabled .layout=${this.layout} scale=s><calcite-action .active=${n} appearance=solid .disabled=${i} .icon=${e.pan} @click=${this._onPanClick} scale=s .text=${o} title=${o ?? r}></calcite-action><calcite-action .active=${!n} appearance=solid .disabled=${i} .icon=${e.rotate} @click=${this._onRotateClick} scale=s .text=${s} title=${s ?? r}></calcite-action></calcite-action-bar>`;
+    const { _messages: t, navigationMode: a, state: l } = this, s = t.pan ?? "", o = t.rotate ?? "", i = l === "disabled", n = a === "pan";
+    return u`<calcite-action-bar class=${v({ [w.base]: !0, [f.disabled]: i })} expand-disabled .layout=${this.layout} scale=s><calcite-action .active=${n} appearance=solid .disabled=${i} .icon=${e.pan} @click=${this._onPanClick} scale=s .text=${s} title=${s ?? r}></calcite-action><calcite-action .active=${!n} appearance=solid .disabled=${i} .icon=${e.rotate} @click=${this._onRotateClick} scale=s .text=${o} title=${o ?? r}></calcite-action></calcite-action-bar>`;
   }
 }
 p("arcgis-navigation-toggle", _);

package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts

@@ -22,13 +22,7 @@ declare const useOrientedImageryViewerWidget: (component: LitElement & Pick<Orie
     }> | undefined;
     el: HTMLElement & {
         childElem
-        /**
-         * 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.
-         */
+        /** @copyDoc */
         ?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
@@ -39,45 +33,140 @@ declare const useOrientedImageryViewerWidget: (component: LitElement & Pick<Orie
 }, options?: {
     editConstructorProperties(props: __esri.OrientedImageryViewerProperties | undefined): __esri.OrientedImageryViewerProperties | Promise<__esri.OrientedImageryViewerProperties | undefined> | undefined;
 } | undefined) => OrientedImageryViewer;
-/** The OrientedImageryViewer component allows the user to explore and use their oriented images.
+/**
+ * The OrientedImageryViewer component allows the user to explore and use their oriented images.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-oriented-imagery-viewer/)
  */
 export declare class ArcgisOrientedImageryViewer 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-oriented-imagery-viewer/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#currentCoverageVisible)
+     *
+     * @default true
+     */
     currentCoverageVisible: boolean;
+    /**
+     * Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#dataCaptureEnabled)
+     *
+     * @default false
+     */
     dataCaptureEnabled: boolean;
+    /**
+     * When `false`, the view click interaction is enabled for the oriented imagery viewer widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#disabled)
+     *
+     * @default false
+     */
     disabled: boolean;
+    /**
+     * Indicates if the image gallery functionality is available in the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#galleryOpened)
+     *
+     * @default false
+     */
     galleryOpened: 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 displayed in the widget's button.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#icon)
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "oriented-imagery-widget"
      */
     icon: string;
+    /**
+     * Indicates if the image enhancement tool is active.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageEnhancementToolActive)
+     *
+     * @default false
+     */
     imageEnhancementToolActive: boolean;
+    /**
+     * When `true`, the image gallery functionality is available in the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageGalleryEnabled)
+     *
+     * @default false
+     */
     readonly imageGalleryEnabled: boolean;
+    /**
+     * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalCoverageVisible)
+     *
+     * @default false
+     */
     isAdditionalCoverageVisible: boolean;
+    /**
+     * Indicates if the additional camera locations are visible for the selected image loaded in the viewer.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalPointSourcesVisible)
+     *
+     * @default false
+     */
     isAdditionalPointSourcesVisible: boolean;
-    /** The component's default label. */
+    /**
+     * The widget's label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)
+     */
     label: string | nullish;
+    /**
+     * Specifies the current [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) to use.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#layer)
+     */
     layer: nullish | OrientedImageryLayer;
+    /**
+     * Indicates if the map-image location tool is available in the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#mapImageConversionToolState)
+     *
+     * @default false
+     */
     mapImageConversionToolState: boolean;
+    /**
+     * When `true`, the navigation tool is available in the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#navigationToolActive)
+     *
+     * @default false
+     */
     navigationToolActive: boolean;
     orientedImageryLayerItemId?: string;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * This property provides the location of an image pixel in Map coordinates when using map-image conversion tool.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#referencePoint)
+     */
     readonly referencePoint: nullish | __esri.Point;
-    /** Permanently destroy the component */
+    /** 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: TargetedEvent<this, {
         name: "layer" | "imageGalleryEnabled";
     }>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, undefined>;
 }
 export {};

package/dist/components/arcgis-oriented-imagery-viewer/customElement.js

@@ -7,7 +7,7 @@ import { m as l } from "../../chunks/useWidget.js";
 import { css as g } 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.110 */
+v4.33.0-next.112 */
 const h = g`@layer{arcgis-oriented-imagery-viewer{display:block}}`, m = l(r);
 class y extends o {
   constructor() {
@@ -22,14 +22,9 @@ class y extends o {
   static {
     this.styles = h;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
-  //#endregion
-  //#region Lifecycle
   willUpdate(e) {
     if (e.has("orientedImageryLayerItemId")) {
       const i = this.orientedImageryLayerItemId;
@@ -41,8 +36,6 @@ class y extends o {
       this._onReady();
     }, { once: !0 }));
   }
-  //#endregion
-  //#region Private Methods
   _onReady() {
     const { layer: e } = this;
     e && (this.widget.view?.map.add(e), this._hasOrientedImageryLayerToAdd = !1);

package/dist/components/arcgis-placement/customElement.d.ts

@@ -5,10 +5,15 @@ import { Nil } from '@arcgis/components-utils';
 import { PropertyValues } from 'lit';
 import { ToElement, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 
-/** The placement component is used to position content relative to the map. This component may be **temporary** until we offer a more robust solution.
+/**
+ * The placement component is used to position content relative to the map. This component may be **temporary** until we offer a more robust solution.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-placement/)
  */
 export declare class ArcgisPlacement extends LitElement {
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, undefined>;
 }

package/dist/components/arcgis-placement/customElement.js

@@ -4,11 +4,9 @@ import { LitElement as l, createEvent as a, noShadowRoot as c } from "@arcgis/lu
 import { css as h } 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.110 */
+v4.33.0-next.112 */
 const d = h`@layer{arcgis-placement{display:flex;pointer-events:auto;box-shadow:none}.arcgis-placement__container{display:block}}`;
 class m extends l {
-  //#endregion
-  //#region Lifecycle
   constructor() {
     super(), this._observer = void 0, this._moveChildren = () => {
       if (i(this).parentElement !== this.el)
@@ -43,15 +41,6 @@ class m extends l {
     const e = i(this);
     e && this.el.view?.ui?.remove(e), this._observer?.disconnect();
   }
-  //#endregion
-  //#region Private Methods
-  /**
-   * We only call this method once the view property is set. Because when that
-   * happens, the childElem contains is already attached to it's final
-   * destination. This is important as we don't want to call _moveChildren()
-   * prematurely (triggering needless disconnect & connect for them, and maybe
-   * even destroy()).
-   */
   _startObserving() {
     this._moveChildren(), this._observer = new MutationObserver(this._moveChildren), this._observer.observe(this.el, { childList: !0 });
   }