@arcgis/map-components 5.2.0-next.1 → 5.2.0-next.100

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

@@ -1,24 +1,25 @@
 /// <reference path="../../index.d.ts" />
-import type Collection from "@arcgis/core/core/Collection.js";
 import type Point from "@arcgis/core/geometry/Point.js";
 import type Conversion from "@arcgis/core/widgets/CoordinateConversion/support/Conversion.js";
 import type Format from "@arcgis/core/widgets/CoordinateConversion/support/Format.js";
+import type Collection from "@arcgis/core/core/Collection.js";
 import type PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol.js";
 import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol.js";
 import type CIMSymbol from "@arcgis/core/symbols/CIMSymbol.js";
 import type PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisReferenceElement, IconName, HeadingLevel } from "../types.js";
-import type { LengthUnit } from "@arcgis/core/core/units.js";
 import type { Orientation, StorageType } from "./types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
 import type { GoToOverride } from "@arcgis/core/widgets/support/types.js";
 import type { Mode } from "@arcgis/core/widgets/types.js";
-import type { Panel as Panel } from "@esri/calcite-components/components/calcite-panel";
 import type { CoordinateConversionViewModelState } from "@arcgis/core/widgets/CoordinateConversion/CoordinateConversionViewModel.js";
 
 /**
+ * > [!NOTE]
+ * > In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) , and deprecated properties on this component will be removed. We encourage using the [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) component and providing feedback.
+ *
  * 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/references/core/geometry/Point/).
@@ -53,6 +54,15 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * prevent memory leaks.
    *
    * @default false
+   * @example
+   * ```html
+   * <arcgis-coordinate-conversion auto-destroy-disabled></arcgis-coordinate-conversion>
+   * ```
+   *
+   * ```js
+   * coordinateConversionElement.autoDestroyDisabled = true;
+   * ```
+   * 
    */
   accessor autoDestroyDisabled: boolean;
   /**
@@ -82,8 +92,13 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
   /**
    * Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.
    *
-   * @deprecated since 5.1, the component no longer has expand/collapse functionality
+   * @deprecated since 5.1. The expand/collapse functionality will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).
    * @default false
+   * @example
+   * Expand the component.
+   * ```js
+   * coordinateConversionComponent.expanded = true;
+   * ```
    */
   accessor expanded: boolean;
   /**
@@ -135,55 +150,49 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
   /**
    * Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.
    *
-   * @deprecated since 5.1, use `hideCaptureSection` instead
+   * @deprecated since 5.1. The capture button will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).
    * @default false
-   */
-  accessor hideCaptureButton: boolean;
-  /**
-   * Determines whether the capture section will be shown in the component. If `true`, the capture section will be hidden.
-   *
-   * @default false
-   * @since 5.1
    * @example
-   * Hide the capture section.
+   * Hide the capture button.
    * ```html
    * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-   *   <arcgis-coordinate-conversion hide-capture-section slot="bottom-left"></arcgis-coordinate-conversion>
+   *   <arcgis-coordinate-conversion hide-capture-button slot="bottom-left"></arcgis-coordinate-conversion>
    * </arcgis-map>
    * ```
    */
-  accessor hideCaptureSection: boolean;
+  accessor hideCaptureButton: boolean;
   /**
    * Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.
    *
-   * @deprecated since 5.1, the component no longer has expand/collapse functionality
+   * @deprecated since 5.1. The expand/collapse functionality will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).
    * @default false
+   * @example
+   * Hide the expand button.
+   * ```html
+   * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
+   *   <arcgis-coordinate-conversion hide-expand-button slot="bottom-left"></arcgis-coordinate-conversion>
+   * </arcgis-map>
+   * ```
    */
   accessor hideExpandButton: boolean;
   /**
    * Determines whether the input coordinate button will be shown in the component. If `true`, the input button will be hidden.
    *
-   * @deprecated since 5.1, use `hideInputSection` instead
-   * @default false
-   */
-  accessor hideInputButton: boolean;
-  /**
-   * Determines whether the input section will be shown in the component. If `true`, the input section will be hidden.
-   *
+   * @deprecated since 5.1. The input button will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).
    * @default false
-   * @since 5.1
    * @example
-   * Hide the input section.
+   * Hide the input button.
    * ```html
    * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-   *   <arcgis-coordinate-conversion hide-input-section slot="bottom-left"></arcgis-coordinate-conversion>
+   *   <arcgis-coordinate-conversion hide-input-button slot="bottom-left"></arcgis-coordinate-conversion>
    * </arcgis-map>
    * ```
    */
-  accessor hideInputSection: boolean;
+  accessor hideInputButton: boolean;
   /**
    * Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.
    *
+   * @deprecated since 5.1. The settings button will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).
    * @default false
    * @example
    * Hide the settings button.
@@ -216,7 +225,7 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    *
    * @default "Coordinate conversion"
    */
-  accessor label: string;
+  accessor label: string | undefined;
   /**
    * This symbol is used to visualize the location currently described by the component when `capture` mode
    * is active.
@@ -232,7 +241,7 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    */
   accessor locationSymbol: PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D;
   /** @internal */
-  protected messages: {
+  protected messages: Partial<{
       componentLabel: string;
       abbreviatedDirections: {
           north: string;
@@ -242,45 +251,28 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
       };
       addConversion: string;
       alertLabel: string;
+      back: string;
       captureMode: string;
-      display: string;
+      changeCoordinateDisplay: string;
+      collapse: string;
       convert: string;
-      convertAndGoTo: string;
-      coordinates: string;
-      copyLabel: string;
-      copyElevationLabel: string;
+      conversionOutput: string;
+      copy: string;
       copySuccessMessage: string;
       defaultPattern: string;
-      done: string;
-      elevation: string;
-      selectElevationUnit: string;
-      format: string;
-      formatDescriptions: {
-          dd: string;
-          dms: string;
-          ddm: string;
-          mgrs: string;
-          usng: string;
-          utm: string;
-          xy: string;
-          basemap: string;
-          custom: string;
-      };
-      input: string;
+      expand: string;
+      goTo: string;
       inputCoordTitle: string;
-      inputFormat: string;
       invalidCoordinate: string;
       liveMode: string;
       locationOffBasemap: string;
       noBasemap: string;
-      noDisplayProperties: string;
-      noElevation: string;
       noLocation: string;
       preview: string;
+      removeConversion: string;
       selectFormat: string;
-      selectFormats: string;
-      settingsTitleWithFormat: string;
-  } & T9nMeta<{
+      settingsTitle: string;
+  }> & T9nMeta<{
       componentLabel: string;
       abbreviatedDirections: {
           north: string;
@@ -290,44 +282,27 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
       };
       addConversion: string;
       alertLabel: string;
+      back: string;
       captureMode: string;
-      display: string;
+      changeCoordinateDisplay: string;
+      collapse: string;
       convert: string;
-      convertAndGoTo: string;
-      coordinates: string;
-      copyLabel: string;
-      copyElevationLabel: string;
+      conversionOutput: string;
+      copy: string;
       copySuccessMessage: string;
       defaultPattern: string;
-      done: string;
-      elevation: string;
-      selectElevationUnit: string;
-      format: string;
-      formatDescriptions: {
-          dd: string;
-          dms: string;
-          ddm: string;
-          mgrs: string;
-          usng: string;
-          utm: string;
-          xy: string;
-          basemap: string;
-          custom: string;
-      };
-      input: string;
+      expand: string;
+      goTo: string;
       inputCoordTitle: string;
-      inputFormat: string;
       invalidCoordinate: string;
       liveMode: string;
       locationOffBasemap: string;
       noBasemap: string;
-      noDisplayProperties: string;
-      noElevation: string;
       noLocation: string;
       preview: string;
+      removeConversion: string;
       selectFormat: string;
-      selectFormats: string;
-      settingsTitleWithFormat: string;
+      settingsTitle: string;
   }>;
   /**
    * Describes the current mode of the component.
@@ -335,15 +310,13 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * * While in `live` mode, the component will update as the cursor moves.
    * * While in `capture` mode, the component will update on mouse click and display a graphic
    * marking the current location.
-   * * While in `idle` mode, the component will not update based on cursor movement or mouse clicks.
-   * This mode can be used to "pause" the component without losing the current location.
    *
    * @default "live"
    * @example
-   * Programmatically set the component to idle mode.
+   * Programmatically set the component to capture mode.
    * ```js
    * const coordinateConversionComponent = document.getElementsByTagName("arcgis-coordinate-conversion")[0];
-   * coordinateConversionComponent.mode = "idle";
+   * coordinateConversionComponent.mode = "capture";
    * ```
    */
   accessor mode: Mode;
@@ -357,7 +330,6 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * 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.
    *
-   * @deprecated 5.1, the component no longer has an orientation
    * @default "auto"
    */
   accessor orientation: Orientation;
@@ -376,13 +348,6 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * @since 5.1
    */
   accessor removeLeadingZeros: boolean;
-  /**
-   * Determines whether the elevation of the current location will be shown. Only applicable when the view is a SceneView.
-   *
-   * @default false
-   * @since 5.1
-   */
-  accessor showElevation: boolean;
   /**
    * The current state of the component.
    *
@@ -400,31 +365,16 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * This property determines whether sessionStorage or localStorage will be used to store component's state.
    *
    * @default "session"
-   * @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)
+   * @see [Window.sessionStorage](https://developer.mozilla.org/docs/Web/API/Window/sessionStorage)
+   * @see [Window.localStorage](https://developer.mozilla.org/docs/Web/API/Window/localStorage)
    * @since 4.23
    */
   accessor storageType: StorageType;
   /**
-   * Indicates the vertical unit to use when displaying elevation.
-   *
-   * @default "meters"
-   * @since 5.1
-   * @see [LengthUnit](https://developers.arcgis.com/javascript/latest/references/core/core/units/#LengthUnit)
-   */
-  accessor verticalUnit: LengthUnit;
-  /**
-   * The view associated with the component. 
-   *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-coordinate-conversion component will be associated with a map or scene component rather than using the `view` property.
+   * The view associated with the component.
+   * > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-coordinate-conversion component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapViewOrSceneView | null | undefined;
-  /**
-   * Determines the component's scale. Options are small ("s"), medium ("m"), and large ("l").
-   *
-   * @default "s"
-   * @since 5.1
-   */
-  accessor visualScale: Panel["scale"];
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
   /**
@@ -444,7 +394,7 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    */
   readonly arcgisConversionChange: import("@arcgis/lumina").TargetedEvent<this, void>;
   /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
-  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "currentLocation" | "state" | "mode" | "verticalUnit"; }>;
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "currentLocation" | "state" | "expanded" | "mode"; }>;
   /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
   readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   readonly "@eventTypes": {