@arcgis/map-components 5.0.0-next.10 → 5.0.0-next.101

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

@@ -1,29 +1,29 @@
-import { c } from "../../chunks/runtime.js";
+import { c as r } from "../../chunks/runtime.js";
 import { css as n, html as l } from "lit";
-import d from "@arcgis/core/widgets/Compass/CompassViewModel.js";
-import { LitElement as h, createEvent as m, safeClassMap as i, nothing as a, safeStyleMap as u } from "@arcgis/lumina";
-import { usePropertyChange as p } from "@arcgis/lumina/controllers";
-import { classes as v } from "@arcgis/toolkit/dom";
+import h from "@arcgis/core/widgets/Compass/CompassViewModel.js";
+import { LitElement as d, createEvent as m, safeClassMap as o, nothing as a, safeStyleMap as u } from "@arcgis/lumina";
+import { usePropertyChange as v } from "@arcgis/lumina/controllers";
+import { classes as p } from "@arcgis/toolkit/dom";
 import { u as g } from "../../chunks/useT9n.js";
-import { m as f } from "../../chunks/useViewModel.js";
+import { m as b } from "../../chunks/useViewModel.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.10 */
-const b = n`.arcgis-button{--calcite-ui-icon-color: var(--calcite-color-text-3);--calcite-button-background-color: var(--calcite-color-foreground-1);color:var(--calcite-color-text-3);line-height:var(--calcite-font-line-height-relative-tight);display:flex;flex-flow:column;cursor:pointer;background-color:var(--calcite-color-foreground-1);font-size:var(--calcite-font-size);:hover{--calcite-ui-icon-color: var(--calcite-color-text-1);--calcite-button-background-color: var(--calcite-color-transparent-hover)}calcite-button{width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl)}}:host{width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl)}.compass{border-radius:50%;box-shadow:var(--arcgis-internal-box-shadow, none)}.compass__icon-container{justify-content:center;display:flex;position:absolute;transform:translate(-50%,-50%)}.compass__icon-container:dir(rtl){transform:translate(50%,-50%)}`, o = "compass", e = {
-  base: o,
+v5.0.0-next.101 */
+const f = n`.arcgis-button{--calcite-icon-color: var(--calcite-color-text-3);--calcite-button-background-color: var(--calcite-color-foreground-1);color:var(--calcite-color-text-3);line-height:var(--calcite-font-line-height-relative-tight);display:flex;flex-flow:column;cursor:pointer;background-color:var(--calcite-color-foreground-1);font-size:var(--calcite-font-size);:hover{--calcite-icon-color: var(--calcite-color-text-1);--calcite-button-background-color: var(--calcite-color-transparent-hover)}}:host{calcite-button{width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl)}}:host([visual-scale="l"]){calcite-button{width:calc(var(--calcite-spacing-xxxl) + var(--calcite-spacing-md));height:calc(var(--calcite-spacing-xxxl) + var(--calcite-spacing-md))}}:host([visual-scale="s"]){calcite-button{width:var(--calcite-spacing-xxl);height:var(--calcite-spacing-xxl)}}.compass{border-radius:50%;box-shadow:var(--arcgis-internal-box-shadow, none)}.compass__icon-container{justify-content:center;display:flex;position:absolute;transform:translate(-50%,-50%)}.compass__icon-container:dir(rtl){transform:translate(50%,-50%)}`, s = "compass", e = {
+  base: s,
   button: "arcgis-button",
-  compassButton: `${o}__button`,
-  iconContainer: `${o}__icon-container`
-}, x = f(d);
-class w extends h {
+  compassButton: `${s}__button`,
+  iconContainer: `${s}__icon-container`
+}, x = b(h);
+class w extends d {
   constructor() {
-    super(...arguments), this.messages = g(), this.viewModel = x(this), this.view = this.viewModel.view, this.autoDestroyDisabled = !1, this.goToOverride = this.viewModel.goToOverride, this.orientation = this.viewModel.orientation, this.state = this.viewModel.state, this.arcgisPropertyChange = p()("state", "orientation"), this.arcgisReady = m();
+    super(...arguments), this.messages = g(), this.viewModel = x(this), this.view = this.viewModel.view, this.autoDestroyDisabled = !1, this.goToOverride = this.viewModel.goToOverride, this.orientation = this.viewModel.orientation, this.state = this.viewModel.state, this.visualScale = "m", this.arcgisPropertyChange = v()("state", "orientation"), this.arcgisReady = m();
   }
   static {
-    this.properties = { view: 0, autoDestroyDisabled: 5, goToOverride: 0, icon: 3, label: 1, messageOverrides: 0, orientation: 0, position: 3, referenceElement: 1, state: 3 };
+    this.properties = { view: 0, autoDestroyDisabled: 5, goToOverride: 0, icon: 2, label: 1, messageOverrides: 0, orientation: 0, position: 3, referenceElement: 1, state: 3, visualScale: 1 };
   }
   static {
-    this.styles = b;
+    this.styles = f;
   }
   get icon() {
     return this._icon ?? (this.state === "rotation" ? "arrow-up" : "compass-needle");
@@ -41,14 +41,14 @@ class w extends h {
     this.viewModel.reset();
   }
   render() {
-    const { messages: t, icon: r } = this;
-    return l`<div class=${i(v(e.base, e.button, e.compassButton))}><calcite-button .disabled=${this.state === "disabled"} kind=neutral .label=${t.reset} @click=${this._reset} round scale=s title=${t.reset ?? a}><div aria-hidden=true class=${i(e.iconContainer)} title=${t.reset ?? a}><calcite-icon .icon=${r} style=${u(y(this.orientation))}></calcite-icon></div></calcite-button></div>`;
+    const { messages: t, icon: c } = this;
+    return l`<div class=${o(p(e.base, e.button, e.compassButton))}><calcite-button .disabled=${this.state === "disabled"} kind=neutral .label=${t.reset} @click=${this._reset} round .scale=${this.visualScale} title=${t.reset ?? a}><div aria-hidden=true class=${o(e.iconContainer)} title=${t.reset ?? a}><calcite-icon .scale=${this.visualScale} .icon=${c} style=${u(y(this.orientation))}></calcite-icon></div></calcite-button></div>`;
   }
 }
-const y = (s) => ({
-  transform: `rotateZ(${s.z}deg)`
+const y = (i) => ({
+  transform: `rotateZ(${i.z}deg)`
 });
-c("arcgis-compass", w);
+r("arcgis-compass", w);
 export {
   w as ArcgisCompass
 };

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

@@ -9,10 +9,11 @@ import { default as Conversion } from '@arcgis/core/widgets/CoordinateConversion
 import { default as CoordinateConversionViewModel } from '@arcgis/core/widgets/CoordinateConversion/CoordinateConversionViewModel.js';
 import { default as Format } from '@arcgis/core/widgets/CoordinateConversion/support/Format.js';
 import { View, AlertProperties, Orientation, StorageType } from './interfaces';
+import { IconName } from '../../utils/action-utils';
 
 declare const useCoordinateConversionViewModel: (component: LitElement & Pick<CoordinateConversionViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<CoordinateConversionViewModel>) => CoordinateConversionViewModel;
 /**
- * The CoordinateConversion component provides a way to display user cursor position either as map coordinates or
+ * The Coordinate Conversion 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).
  *
@@ -33,18 +34,18 @@ declare const useCoordinateConversionViewModel: (component: LitElement & Pick<Co
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-coordinate-conversion/)
  *
  * @example
- * ```tsx
+ * ```html
  * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
- *   <arcgis-coordinate-conversion position="bottom-left"></arcgis-coordinate-conversion>
+ *   <arcgis-coordinate-conversion slot="bottom-left"></arcgis-coordinate-conversion>
  * </arcgis-map>
  * ```
  */
 export declare class ArcgisCoordinateConversion extends LitElement {
     /**
      * 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 ArcgisCoordinateConversion component will be associated with a map or scene component rather than using the `view` property.
+     *   > **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 Coordinate Conversion component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: __esri.MapView | __esri.SceneView | nullish;
+    view?: import('@arcgis/core/views/MapViewOrSceneView').MapViewOrSceneView | null | undefined;
     /**
      * 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
@@ -61,34 +62,39 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      *
      * @type {Collection<Conversion>}
      * @example
-     * Conversions can be set with an array of strings where each string is a format's name
-     * ```ts
+     * Conversions can be set with an array of strings where each string is a format's name.
+     * ```js
      * coordinateConversionComponent.conversions = ["mgrs"];
      * ```
+     * @since 4.7
+     * @example
+     * // conversions can be set with an array of strings where each string is a format's name
+     * coordinateConversion.conversions = ["mgrs"];
      */
-    conversions: __esri.Collection<Conversion>;
+    conversions: import('@arcgis/core/core/Collection').default<Conversion>;
     /**
      * Describes the location of the coordinates currently displayed by the component as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).
      * Setting this property will update all conversions.
      *
      * @type {Point}
      * @example
-     * Set the current location
-     * ```ts
+     * Set the current location.
+     * ```js
      * coordinateConversionComponent.currentLocation = { x: 77.0369, y: 38.9072, spatialReference: { wkid: 4326 } };
      * ```
+     * @since 4.7
      */
-    currentLocation?: Point | nullish;
+    currentLocation?: Point | null | undefined;
     /**
-     * Describes whether the  component is expanded or not. Can be set manually to expand or retract the component.
+     * Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.
      *
+     * @default false
      * @type {boolean}
      * @example
-     * Expand the component
-     * ```ts
+     * Expand the component.
+     * ```js
      * coordinateConversionComponent.expanded = true;
      * ```
-     * @default false
      */
     expanded: boolean;
     /**
@@ -99,100 +105,104 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      *
      * @type {Collection<Format>}
      * @example
-     * Only show the "xy" format
-     * ```ts
+     * Only show the "xy" format.
+     * ```js
      * const coordinateConversionComponent = document.getElementsByTagName("arcgis-coordinate-conversion")[0];
      * const toRemove = coordinateConversionComponent.formats.filter(format => format.name !== "xy");
      * coordinateConversionComponent.formats.removeMany(toRemove);
      * ```
      * @example
-     * Show every format except "xy"
-     * ```ts
+     * Show every format except "xy".
+     * ```js
      * const coordinateConversionComponent = document.getElementsByTagName("arcgis-coordinate-conversion")[0];
      * const toRemove = coordinateConversionComponent.formats.filter(format => format.name === "xy");
      * coordinateConversionComponent.formats.removeMany(toRemove);
      * ```
      */
-    formats: __esri.Collection<Format>;
+    formats: import('@arcgis/core/core/Collection').default<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-CoordinateConversionViewModel.html#goToOverride)
-     *
      * @since 4.33
+     * @see [MapView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)
+     * @see [SceneView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)
+     * @example
+     * // The following snippet uses Search but can be applied to any
+     * // widgets that support the goToOverride property.
+     * search.goToOverride = function(view, goToParams) {
+     *   goToParams.options = {
+     *     duration: updatedDuration
+     *   };
+     *   return view.goTo(goToParams.target, goToParams.options);
+     * };
      */
-    goToOverride: nullish | __esri.GoToOverride;
+    goToOverride: import('@arcgis/core/widgets/support/types').GoToOverride | null | undefined;
     /**
      * Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,
      * these headings are rendered as level 4 headings (e.g. `<h4>Input coordinate</h4>`). Depending on the coordinate conversion component's
      * placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting
      * accessibility standards.
      *
-     * @type {number}
-     * @example
-     * Coordinate conversion heading will render as an <h2>
-     * ```ts
-     * coordinateConversionComponent.headingLevel = 2;
-     * ```ts
      * @default 4
+     * @type {number}
      */
     headingLevel: HeadingLevel;
     /**
-     * Determines whether the capture button will be shown in the component
+     * Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.
      *
+     * @default false
      * @type {boolean}
      * @example
-     * Hide the capture button
-     * ```tsx
+     * Hide the capture button.
+     * ```html
      * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-     *   <arcgis-coordinate-conversion hide-capture-button position="bottom-left"></arcgis-coordinate-conversion>
+     *   <arcgis-coordinate-conversion hide-capture-button slot="bottom-left"></arcgis-coordinate-conversion>
      * </arcgis-map>
      * ```
-     * @default false
      */
     hideCaptureButton: boolean;
     /**
-     * Determines whether the edit button will be shown in the component
+     * Determines whether the input coordinate button will be shown in the component. If `true`, the input button will be hidden.
      *
+     * @default false
      * @type {boolean}
      * @example
-     * Hide the edit button
-     * ```tsx
+     * Hide the input button.
+     * ```html
      * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-     *   <arcgis-coordinate-conversion hide-edit-button position="bottom-left"></arcgis-coordinate-conversion>
+     *   <arcgis-coordinate-conversion hide-input-button slot="bottom-left"></arcgis-coordinate-conversion>
      * </arcgis-map>
      * ```
-     * @default false
      */
     hideInputButton: boolean;
     /**
-     * Determines whether the expand button will be shown in the component
+     * Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.
      *
+     * @default false
      * @type {boolean}
      * @example
-     * Hide the capture button
-     * ```tsx
+     * Hide the expand button.
+     * ```html
      * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-     *   <arcgis-coordinate-conversion hide-expand-button position="bottom-left"></arcgis-coordinate-conversion>
+     *   <arcgis-coordinate-conversion hide-expand-button slot="bottom-left"></arcgis-coordinate-conversion>
      * </arcgis-map>
      * ```
-     * @default false
      */
     hideExpandButton: boolean;
     /**
-     * Determines whether the settings button will be shown in the component
+     * Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.
      *
+     * @default false
      * @type {boolean}
      * @example
-     * Hide the capture button
-     * ```tsx
+     * Hide the settings button.
+     * ```html
      * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-     *   <arcgis-coordinate-conversion hide-settings-button position="bottom-left"></arcgis-coordinate-conversion>
+     *   <arcgis-coordinate-conversion hide-settings-button slot="bottom-left"></arcgis-coordinate-conversion>
      * </arcgis-map>
      * ```
-     * @default false
      */
     hideSettingsButton: boolean;
     /**
@@ -202,7 +212,7 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      *
      * @default "coordinate-system"
      */
-    icon: string;
+    icon: IconName;
     /**
      * The component's default label.
      *
@@ -213,17 +223,17 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      * This symbol is used to visualize the location currently described by the component when `capture` mode
      * is active.
      *
-     * This property should be set to an Esri JS API point symbol, typically a [Simple Marker Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html)
+     * This property should be set to a point symbol, typically a [Simple Marker Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html).
      *
      * @type {SimpleMarkerSymbol}
      * @example
-     * Set the location symbol to be an 'x'
-     * ```ts
+     * Set the location symbol to be an 'x'.
+     * ```js
      * const coordinateConversionComponent = document.getElementsByTagName("arcgis-coordinate-conversion")[0];
      * coordinateConversionComponent.locationSymbol = { type: "simple-marker", style: "x" };
      * ```
      */
-    locationSymbol: __esri.PictureMarkerSymbol | __esri.SimpleMarkerSymbol | __esri.CIMSymbol | __esri.PointSymbol3D;
+    locationSymbol: import('@arcgis/core/symbols/PictureMarkerSymbol').default | import('@arcgis/core/symbols/SimpleMarkerSymbol').default | import('@arcgis/core/symbols/CIMSymbol').default | import('@arcgis/core/symbols/PointSymbol3D').default;
     /**
      * Describes the current mode of the component.
      *
@@ -231,25 +241,33 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      * * While in `capture` mode, the component will update on mouse click and display a graphic
      * marking the current location.
      *
+     * @default "live"
      * @type {"live" | "capture"}
      * @example
-     * Programmatically set the component to capture mode
-     * ```ts
+     * Programmatically set the component to capture mode.
+     * ```js
      * const coordinateConversionComponent = document.getElementsByTagName("arcgis-coordinate-conversion")[0];
      * coordinateConversionComponent.mode = "capture";
      * ```
-     * @default "live"
      */
-    mode: "live" | "capture";
+    mode: import('@arcgis/core/widgets/types').Mode;
     /**
-     * Determines whether the component should expand up or down.  If set to `auto`
+     * If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.
+     *
+     * @default false
+     * @type {boolean}
+     */
+    get multipleConversionsDisabled(): boolean;
+    set multipleConversionsDisabled(value: boolean);
+    /**
+     * Determines whether the component should expand up or down.  If set to `auto`,
      * the component will be oriented based on its position in the view.
      *
-     * @type {"auto" | "expand-up" | "expand-down"}
      * @default "auto"
+     * @type {"auto" | "expand-up" | "expand-down"}
      */
     orientation: Orientation;
-    /** @deprecated since 4.34, use `slot` instead. */
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
     position?: __esri.UIPosition;
     /**
      * 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.
@@ -262,31 +280,25 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      *
      * @default "disabled"
      */
-    readonly state: "ready" | "loading" | "disabled";
-    /**
-     * If this property is set to `true`, only a single conversion can be displated.  For a simpler experience with only
-     * one conversion at a time, this property can be set to `true`.
-     *
-     * @type {boolean}
-     * @default false
-     */
-    get singleConversion(): boolean;
-    set singleConversion(value: boolean);
+    readonly state: import('@arcgis/core/widgets/CoordinateConversion/CoordinateConversionViewModel.js').CoordinateConversionViewModelState;
     /**
      * If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType))
      * will not be used to hydrate and persist the component's state.
      *
-     * @type {boolean}
      * @default false
+     * @type {boolean}
      */
     storageDisabled: boolean;
     /**
      * This property determines whether sessionStorage or localStorage will be used to store component's state.
      *
+     * @default "session"
      * @type {"session" | "local"}
      * @see [Window.sessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
      * @see [Window.localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
-     * @default "session"
+     * @since 4.23
+     * @see [Window.sessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
+     * @see [Window.localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
      */
     storageType: StorageType;
     /** Permanently destroy the component. */
@@ -296,15 +308,22 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      * string must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of available formats can be
      * obtained from the [formats](#formats) property.
      *
+     * @param coordinate
+     * @param format
      * @param coordinate - The coordinate string.
      * @param  ://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html} format - Specifies the format of the input coordinate.
      * @return ://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html | nil>} When resolved, returns a [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).
      */
     reverseConvert(coordinate: string, format: Format): Promise<__esri.Point | nullish>;
+    /**
+     * Emitted when a conversion is added or removed, or when the order of conversions changes.
+     *
+     * @since 4.34
+     */
     readonly arcgisConversionChange: TargetedEvent<this, void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state" | "expanded" | "mode" | "currentLocation";
+        name: "mode" | "state" | "expanded" | "currentLocation";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;