@arcgis/map-components 4.33.0-next.13 → 4.33.0-next.133

package/dist/components/arcgis-catalog-layer-list/customElement.d.ts

@@ -1,96 +1,179 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
+import { Use } from '@arcgis/lumina/controllers';
 import { Nil } from '@arcgis/components-utils';
 import { default as CatalogLayerList } from '@arcgis/core/widgets/CatalogLayerList.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useCatalogLayerListWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<CatalogLayerList, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+declare const useCatalogLayerListWidget: (component: LitElement & Pick<CatalogLayerList, "icon" | "label" | "viewModel" | "headingLevel" | "collapsed" | "filterPlaceholder" | "filterPredicate" | "filterText" | "listItemCreatedFunction" | "minFilterItems" | "selectedItems" | "selectionMode" | "visibilityAppearance" | "catalogLayer"> & {
     state?: unknown;
     viewModel?: __esri.CatalogLayerListViewModel | undefined;
+    closed?: boolean;
     icon: Nil | string;
     label: Nil | string;
     referenceElement: ArcgisReferenceElement | Nil | string;
-    position: __esri.
-    /**
-     * 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.
-     */
-    UIPosition;
-    arcgisReady: import('@arcgis/components-controllers').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
+    position: __esri.UIPosition;
+    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 | Nil;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.CatalogLayerListProperties | undefined): __esri.CatalogLayerListProperties | Promise<__esri.CatalogLayerListProperties | undefined> | undefined;
-} | undefined) => CatalogLayerList;
-/** The CatalogLayerList component provides a way to display and interact with CatalogLayers.
+}) => CatalogLayerList;
+/**
+ * The CatalogLayerList component provides a way to display and interact with CatalogLayers.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-catalog-layer-list/)
  */
 export declare class ArcgisCatalogLayerList extends LitElement {
+    /**
+     * Emitted when the component's close button is clicked.
+     *
+     * @since 4.33
+     */
+    readonly arcgisClose: TargetedEvent<this>;
     /**
      * 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-catalog-layer-list/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
     /** A collection of ListItems representing the catalogLayers dynamicGroupLayer. */
     get catalogItems(): __esri.Collection<__esri.ListItem>;
+    /**
+     * The [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) to display in the widget.
+     *
+     * @default null
+     */
     catalogLayer: nullish | __esri.CatalogLayer;
+    /**
+     * Indicates whether a component is closed. When `true`, the component will be hidden.
+     *
+     * @since 4.33
+     * @default false
+     */
+    closed: boolean;
+    /**
+     * Indicates whether the widget is collapsed.
+     *
+     * @default false
+     */
     collapsed: boolean;
+    /**
+     * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterPlaceholder: string;
+    /**
+     * Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
+     *
+     * @default null
+     */
     filterPredicate: nullish | __esri.FilterPredicate;
+    /**
+     * The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterText: string;
+    /**
+     * Indicates the heading level to use for the heading of the widget.
+     *
+     * @default 2
+     */
     headingLevel: number;
+    /** @default false */
     hideFlow: boolean;
+    /** @default false */
     hideStatusIndicators: 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 "catalog-dataset"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#label)
+     */
     label: string;
+    /**
+     * A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.
+     *
+     * @default null
+     */
     listItemCreatedFunction: nullish | __esri.CatalogLayerListListItemCreatedHandler;
+    /**
+     * The minimum number of list items required to display the visibleElements.filter input box.
+     *
+     * @default 10
+     */
     minFilterItems: number;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * A collection of selected [ListItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing [catalogItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#catalogItems)
+     * selected by the user.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#selectedItems)
+     */
     selectedItems: __esri.Collection<__esri.ListItem>;
-    selectionMode: "none" | "single" | "multiple" | "single-persist";
+    /**
+     * Specifies the selection mode.
+     *
+     * @default "none"
+     */
+    selectionMode: "single" | "multiple" | "none" | "single-persist";
+    /** @default false */
     showCloseButton: boolean;
+    /** @default false */
     showCollapseButton: boolean;
+    /** @default false */
     showErrors: boolean;
+    /** @default false */
     showFilter: boolean;
+    /** @default false */
     showHeading: boolean;
+    /** @default false */
     showTemporaryLayerIndicators: boolean;
+    /**
+     * The view model's state.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList-CatalogLayerListViewModel.html#state)
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "loading" | "disabled";
+    /**
+     * Determines the icons used to indicate visibility.
+     *
+     * @default "default"
+     */
     visibilityAppearance: "default" | "checkbox";
-    /** 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: "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>;
+    /** Emitted when an action is triggered on the component. */
     readonly arcgisTriggerAction: TargetedEvent<this, __esri.CatalogLayerListTriggerActionEvent>;
 }
 export {};

package/dist/components/arcgis-catalog-layer-list/customElement.js

@@ -1,39 +1,36 @@
 import { c as t } from "../../chunks/runtime.js";
-import { usePropertyChange as e } from "@arcgis/components-controllers";
-import { reEmitEvent as i } from "@arcgis/components-controllers/accessor";
+import { usePropertyChange as e } from "@arcgis/lumina/controllers";
+import { reEmitEvent as i } from "@arcgis/lumina/controllers/accessor";
 import s from "@arcgis/core/widgets/CatalogLayerList.js";
 import { LitElement as o, createEvent as a, noShadowRoot as l } from "@arcgis/lumina";
 import { m as r } from "../../chunks/useWidget.js";
 import { css as h } from "@lit/reactive-element/css-tag.js";
+import { c as d } from "../../chunks/createCloseEvent.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.13 */
-const d = h`@layer{arcgis-catalog-layer-list{display:block}}`, n = r(s);
-class c extends o {
+v4.33.0-next.133 */
+const c = h`@layer{arcgis-catalog-layer-list{display:block}}`, n = r(s);
+class g extends o {
   constructor() {
-    super(...arguments), this.widget = n(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.catalogLayer = this.widget.catalogLayer, this.collapsed = this.widget.collapsed, this.filterPlaceholder = this.widget.filterPlaceholder, this.filterPredicate = this.widget.filterPredicate, this.filterText = this.widget.filterText, this.headingLevel = this.widget.headingLevel, this.hideFlow = this.widget.visibleElements.flow, this.hideStatusIndicators = this.widget.visibleElements.statusIndicators, this.icon = this.widget.icon, this.label = this.widget.label, this.listItemCreatedFunction = this.widget.listItemCreatedFunction, this.minFilterItems = this.widget.minFilterItems, this.position = "bottom-left", this.selectedItems = this.widget.selectedItems, this.selectionMode = this.widget.selectionMode, this.showCloseButton = this.widget.visibleElements.closeButton, this.showCollapseButton = this.widget.visibleElements.collapseButton, this.showErrors = this.widget.visibleElements.errors, this.showFilter = this.widget.visibleElements.filter, this.showHeading = this.widget.visibleElements.heading, this.showTemporaryLayerIndicators = this.widget.visibleElements.temporaryLayerIndicators, this.state = this.viewModel.state, this.visibilityAppearance = this.widget.visibilityAppearance, this.arcgisPropertyChange = e()("state"), this.arcgisReady = a(), this.arcgisTriggerAction = i(() => this.widget, "trigger-action");
+    super(...arguments), this.widget = n(this), this.viewModel = this.widget.viewModel, this.arcgisClose = d(this), this.autoDestroyDisabled = !1, this.catalogLayer = this.widget.catalogLayer, this.closed = !1, this.collapsed = this.widget.collapsed, this.filterPlaceholder = this.widget.filterPlaceholder, this.filterPredicate = this.widget.filterPredicate, this.filterText = this.widget.filterText, this.headingLevel = this.widget.headingLevel, this.hideFlow = this.widget.visibleElements.flow, this.hideStatusIndicators = this.widget.visibleElements.statusIndicators, this.icon = this.widget.icon, this.label = this.widget.label, this.listItemCreatedFunction = this.widget.listItemCreatedFunction, this.minFilterItems = this.widget.minFilterItems, this.position = "bottom-left", this.selectedItems = this.widget.selectedItems, this.selectionMode = this.widget.selectionMode, this.showCloseButton = this.widget.visibleElements.closeButton, this.showCollapseButton = this.widget.visibleElements.collapseButton, this.showErrors = this.widget.visibleElements.errors, this.showFilter = this.widget.visibleElements.filter, this.showHeading = this.widget.visibleElements.heading, this.showTemporaryLayerIndicators = this.widget.visibleElements.temporaryLayerIndicators, this.state = this.viewModel.state, this.visibilityAppearance = this.widget.visibilityAppearance, this.arcgisPropertyChange = e()("state"), this.arcgisReady = a(), this.arcgisTriggerAction = i(() => this.widget, "trigger-action");
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, catalogItems: 32, catalogLayer: 0, collapsed: 7, filterPlaceholder: 1, filterPredicate: 0, filterText: 1, headingLevel: 9, hideFlow: 5, hideStatusIndicators: 5, icon: 1, label: 1, listItemCreatedFunction: 0, minFilterItems: 9, position: 1, referenceElement: 1, selectedItems: 0, selectionMode: 1, showCloseButton: 5, showCollapseButton: 5, showErrors: 5, showFilter: 5, showHeading: 5, showTemporaryLayerIndicators: 5, state: 3, visibilityAppearance: 1 };
+    this.properties = { autoDestroyDisabled: 5, catalogItems: 32, catalogLayer: 0, closed: 5, collapsed: 7, filterPlaceholder: 1, filterPredicate: 0, filterText: 1, headingLevel: 9, hideFlow: 5, hideStatusIndicators: 5, icon: 1, label: 1, listItemCreatedFunction: 0, minFilterItems: 9, position: 1, referenceElement: 1, selectedItems: 0, selectionMode: 1, showCloseButton: 5, showCollapseButton: 5, showErrors: 5, showFilter: 5, showHeading: 5, showTemporaryLayerIndicators: 5, state: 3, visibilityAppearance: 1 };
   }
   static {
     this.shadowRootOptions = l;
   }
   static {
-    this.styles = d;
+    this.styles = c;
   }
-  /** A collection of ListItems representing the catalogLayers dynamicGroupLayer. */
   get catalogItems() {
     return this.widget.catalogItems;
   }
-  // #endregion
-  // #region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
 }
-t("arcgis-catalog-layer-list", c);
+t("arcgis-catalog-layer-list", g);
 export {
-  c as ArcgisCatalogLayerList
+  g as ArcgisCatalogLayerList
 };

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

@@ -1,45 +1,79 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
+import { Use } from '@arcgis/lumina/controllers';
 import { Nil } from '@arcgis/components-utils';
 import { default as CompassViewModel } from '@arcgis/core/widgets/Compass/CompassViewModel.js';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useCompassViewModel: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<CompassViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<CompassViewModel>, options?: {
-    editConstructorProperties(props: unknown): unknown;
-} | undefined) => CompassViewModel;
-/** The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading).
+declare const useCompassViewModel: (component: LitElement & Pick<CompassViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<CompassViewModel>) => CompassViewModel;
+/**
+ * The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading).
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-compass/)
  */
 export declare class ArcgisCompass extends LitElement {
-    private messages;
     /**
      * 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-compass/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * This function provides the ability to override either the
+     * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
+     * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#goToOverride)
+     */
+    goToOverride: nullish | __esri.GoToOverride;
+    /**
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     */
     get icon(): string | undefined;
     set icon(value: string | undefined);
     /** The component's default label. */
     label: Nil | string;
+    /** Replace localized message strings with your own strings. */
     messageOverrides?: typeof this.messages._overrides;
+    /**
+     * The z axis orientation.
+     *
+     * @default { z: 0 }
+     */
     readonly orientation: __esri.Orientation;
+    /** @default "top-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * The view model's state.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Compass-CompassViewModel.html#state)
+     *
+     * @default "disabled"
+     */
     readonly state: "rotation" | "disabled" | "compass";
     destroy(): Promise<void>;
     reset(): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "orientation" | "state";
+        name: "state" | "orientation";
+    }>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    private messages: Partial<{
+        componentLabel: string;
+        reset: string;
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        componentLabel: string;
+        reset: string;
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
 }
 export {};

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

@@ -1,32 +1,32 @@
 import { c } from "../../chunks/runtime.js";
 import { html as l } from "lit-html";
-import { usePropertyChange as m } from "@arcgis/components-controllers";
+import { usePropertyChange as m } from "@arcgis/lumina/controllers";
 import { classes as d } from "@arcgis/components-utils";
 import h from "@arcgis/core/widgets/Compass/CompassViewModel.js";
 import { LitElement as p, createEvent as g, noShadowRoot as u, safeClassMap as s, nothing as o, safeStyleMap as f } from "@arcgis/lumina";
-import { u as y } from "../../chunks/useView.js";
+import { u as v } from "../../chunks/useT9n.js";
 import { m as w } from "../../chunks/useViewModel.js";
 import { g as i } from "../../chunks/globalCss.js";
-import { css as $ } from "@lit/reactive-element/css-tag.js";
+import { css as y } 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.13 */
-const b = $`@layer{arcgis-compass{display:block}}`, a = "esri-compass", r = {
-  base: a,
-  iconContainer: `${a}__icon-container`
-}, v = w(h);
-class C extends p {
+v4.33.0-next.133 */
+const $ = y`@layer{arcgis-compass{display:block}}`, r = "esri-compass", a = {
+  base: r,
+  iconContainer: `${r}__icon-container`
+}, b = w(h);
+class M extends p {
   constructor() {
-    super(...arguments), this.messages = y(), this.viewModel = v(this), this.autoDestroyDisabled = !1, this.orientation = this.viewModel.orientation, this.position = "top-left", this.state = this.viewModel.state, this.arcgisPropertyChange = m()("state", "orientation"), this.arcgisReady = g();
+    super(...arguments), this.messages = v(), this.viewModel = b(this), this.autoDestroyDisabled = !1, this.goToOverride = this.viewModel.goToOverride, this.orientation = this.viewModel.orientation, this.position = "top-left", this.state = this.viewModel.state, this.arcgisPropertyChange = m()("state", "orientation"), this.arcgisReady = g();
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, icon: 3, label: 1, messageOverrides: 0, orientation: 0, position: 3, referenceElement: 1, state: 3 };
+    this.properties = { autoDestroyDisabled: 5, goToOverride: 0, icon: 3, label: 1, messageOverrides: 0, orientation: 0, position: 3, referenceElement: 1, state: 3 };
   }
   static {
     this.shadowRootOptions = u;
   }
   static {
-    this.styles = b;
+    this.styles = $;
   }
   get icon() {
     return this._icon ?? (this.state === "rotation" ? "arrow-up" : "compass-needle");
@@ -34,30 +34,24 @@ class C extends p {
   set icon(t) {
     this._icon = t;
   }
-  // #endregion
-  // #region Public Methods
   async destroy() {
     await this.manager.destroy();
   }
   async reset() {
     this.viewModel.reset();
   }
-  // #endregion
-  // #region Private Methods
   _reset() {
     this.viewModel.reset();
   }
-  // #endregion
-  // #region Rendering
   render() {
     const { messages: t, icon: n } = this;
-    return l`<div class=${s(d(r.base, i.widget))}><calcite-button class=${s(i.widgetButton)} .disabled=${this.state === "disabled"} kind=neutral .label=${t.reset} @click=${this._reset} round scale=s title=${t.reset ?? o}><div aria-hidden=true class=${s(r.iconContainer)} title=${t.reset ?? o}><calcite-icon .icon=${n} style=${f(M(this.orientation))}></calcite-icon></div></calcite-button></div>`;
+    return l`<div class=${s(d(a.base, i.widget))}><calcite-button class=${s(i.widgetButton)} .disabled=${this.state === "disabled"} kind=neutral .label=${t.reset} @click=${this._reset} round scale=s title=${t.reset ?? o}><div aria-hidden=true class=${s(a.iconContainer)} title=${t.reset ?? o}><calcite-icon .icon=${n} style=${f(C(this.orientation))}></calcite-icon></div></calcite-button></div>`;
   }
 }
-const M = (e) => ({
+const C = (e) => ({
   transform: `rotateZ(${e.z}deg)`
 });
-c("arcgis-compass", C);
+c("arcgis-compass", M);
 export {
-  C as ArcgisCompass
+  M as ArcgisCompass
 };

package/dist/components/arcgis-coordinate-conversion/customElement.d.ts

@@ -1,81 +1,160 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
+import { Use } from '@arcgis/lumina/controllers';
 import { Nil } from '@arcgis/components-utils';
 import { default as CoordinateConversion } from '@arcgis/core/widgets/CoordinateConversion.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useCoordinateConversionWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<CoordinateConversion, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+declare const useCoordinateConversionWidget: (component: LitElement & Pick<CoordinateConversion, "icon" | "label" | "viewModel" | "orientation" | "mode" | "headingLevel" | "goToOverride" | "conversions" | "formats" | "locationSymbol" | "storageType"> & {
     state?: unknown;
     viewModel?: __esri.CoordinateConversionViewModel | undefined;
+    closed?: boolean;
     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<{
+    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 | Nil;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.CoordinateConversionProperties | undefined): __esri.CoordinateConversionProperties | Promise<__esri.CoordinateConversionProperties | undefined> | undefined;
-} | undefined) => CoordinateConversion;
-/** CoordinateConversion component provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the component provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).
+}) => CoordinateConversion;
+/**
+ * CoordinateConversion component provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the component provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-coordinate-conversion/)
  */
 export declare class ArcgisCoordinateConversion 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-coordinate-conversion/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html)
+     * that the widget is currently displaying.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions)
+     */
     conversions: __esri.Collection<__esri.Conversion>;
-    readonly currentLocation: __esri.Point | nullish;
+    /**
+     * Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#currentLocation)
+     */
+    readonly currentLocation: nullish | __esri.Point;
+    /**
+     * A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html)
+     * that the widget is capable of displaying.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats)
+     */
     formats: __esri.Collection<__esri.Format>;
+    /**
+     * This function provides the ability to override either the
+     * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
+     * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#goToOverride)
+     */
+    goToOverride: nullish | __esri.GoToOverride;
+    /**
+     * Indicates the heading level to use for the coordinate input and coordinate settings headings.
+     *
+     * @default 4
+     */
     headingLevel: number;
+    /** @default false */
     hideCaptureButton: boolean | undefined;
+    /** @default false */
     hideEditButton: boolean | undefined;
+    /** @default false */
     hideExpandButton: boolean | undefined;
+    /** @default false */
     hideSettingsButton: boolean | undefined;
     /**
-     * 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 "coordinate-system"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#label)
+     */
     label: string;
+    /**
+     * This symbol is used to visualize the location currently described by the widget when `capture` mode
+     * is active.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#locationSymbol)
+     */
     locationSymbol: __esri.SimpleMarkerSymbol | __esri.PictureMarkerSymbol | __esri.PointSymbol3D | __esri.CIMSymbol;
-    mode: "capture" | "live";
+    /**
+     * Describes the current mode of the widget.
+     *
+     * @default "live"
+     */
+    mode: "live" | "capture";
+    /**
+     * If this property is set to `false`, multiple conversions cannot be displayed.
+     *
+     * @default false
+     */
     multipleConversionsDisabled: boolean;
+    /**
+     * Determines whether the widget should expand up or down.
+     *
+     * @default "auto"
+     */
     orientation: "auto" | "expand-up" | "expand-down";
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * The view model's state.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#state)
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "loading" | "disabled";
+    /**
+     * Unless this property is set to `false`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType))
+     * will be used to hydrate and persist the CoordinateConversion widget's state.
+     *
+     * @default false
+     */
     storageDisabled: boolean;
+    /**
+     * This property determines whether sessionStorage or localStorage will be used to store widget state.
+     *
+     * @default "session"
+     */
     storageType: "local" | "session";
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     reverseConvert(coordinate: string, format: __esri.Format): Promise<__esri.Point | nullish>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state" | "currentLocation";
     }>;
-    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 {};