@arcgis/map-components 5.1.0-next.94 → 5.1.0-next.96

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

@@ -1,14 +1,15 @@
 /// <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";
@@ -80,12 +81,8 @@ 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
    * @default false
-   * @example
-   * Expand the component.
-   * ```js
-   * coordinateConversionComponent.expanded = true;
-   * ```
    */
   accessor expanded: boolean;
   /**
@@ -137,42 +134,52 @@ 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
    * @default false
-   * @example
-   * Hide the capture button.
-   * ```html
-   * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-   *   <arcgis-coordinate-conversion hide-capture-button slot="bottom-left"></arcgis-coordinate-conversion>
-   * </arcgis-map>
-   * ```
    */
   accessor hideCaptureButton: boolean;
   /**
-   * Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.
+   * 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 expand button.
+   * Hide the capture section.
    * ```html
    * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-   *   <arcgis-coordinate-conversion hide-expand-button slot="bottom-left"></arcgis-coordinate-conversion>
+   *   <arcgis-coordinate-conversion hide-capture-section slot="bottom-left"></arcgis-coordinate-conversion>
    * </arcgis-map>
    * ```
    */
+  accessor hideCaptureSection: 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
+   * @default false
+   */
   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.
+   *
+   * @default false
+   * @since 5.1
    * @example
-   * Hide the input button.
+   * Hide the input section.
    * ```html
    * <arcgis-map item-id="45b3b2fb35e94ab09381d0caa0da5946">
-   *   <arcgis-coordinate-conversion hide-input-button slot="bottom-left"></arcgis-coordinate-conversion>
+   *   <arcgis-coordinate-conversion hide-input-section slot="bottom-left"></arcgis-coordinate-conversion>
    * </arcgis-map>
    * ```
    */
-  accessor hideInputButton: boolean;
+  accessor hideInputSection: boolean;
   /**
    * Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.
    *
@@ -194,12 +201,21 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * @default "coordinate-system"
    */
   accessor icon: IconName;
+  /**
+   * If false, the component will estimate coordinate precision based on the current state of the
+   * view. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,
+   * `DDM`, `DMS`, and `XY` formats.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor ignoreCoordinatePrecision: boolean;
   /**
    * The component's default label.
    *
    * @default "Coordinate conversion"
    */
-  accessor label: string | undefined;
+  accessor label: string;
   /**
    * This symbol is used to visualize the location currently described by the component when `capture` mode
    * is active.
@@ -215,7 +231,7 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    */
   accessor locationSymbol: PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D;
   /** @internal */
-  protected messages: Partial<{
+  protected messages: {
       componentLabel: string;
       abbreviatedDirections: {
           north: string;
@@ -225,28 +241,45 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
       };
       addConversion: string;
       alertLabel: string;
-      back: string;
       captureMode: string;
-      changeCoordinateDisplay: string;
-      collapse: string;
+      display: string;
       convert: string;
-      conversionOutput: string;
-      copy: string;
+      convertAndGoTo: string;
+      coordinates: string;
+      copyLabel: string;
+      copyElevationLabel: string;
       copySuccessMessage: string;
       defaultPattern: string;
-      expand: string;
-      goTo: 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;
       inputCoordTitle: string;
+      inputFormat: string;
       invalidCoordinate: string;
       liveMode: string;
       locationOffBasemap: string;
       noBasemap: string;
+      noDisplayProperties: string;
+      noElevation: string;
       noLocation: string;
       preview: string;
-      removeConversion: string;
       selectFormat: string;
-      settingsTitle: string;
-  }> & T9nMeta<{
+      selectFormats: string;
+      settingsTitleWithFormat: string;
+  } & T9nMeta<{
       componentLabel: string;
       abbreviatedDirections: {
           north: string;
@@ -256,27 +289,44 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
       };
       addConversion: string;
       alertLabel: string;
-      back: string;
       captureMode: string;
-      changeCoordinateDisplay: string;
-      collapse: string;
+      display: string;
       convert: string;
-      conversionOutput: string;
-      copy: string;
+      convertAndGoTo: string;
+      coordinates: string;
+      copyLabel: string;
+      copyElevationLabel: string;
       copySuccessMessage: string;
       defaultPattern: string;
-      expand: string;
-      goTo: 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;
       inputCoordTitle: string;
+      inputFormat: string;
       invalidCoordinate: string;
       liveMode: string;
       locationOffBasemap: string;
       noBasemap: string;
+      noDisplayProperties: string;
+      noElevation: string;
       noLocation: string;
       preview: string;
-      removeConversion: string;
       selectFormat: string;
-      settingsTitle: string;
+      selectFormats: string;
+      settingsTitleWithFormat: string;
   }>;
   /**
    * Describes the current mode of the component.
@@ -284,13 +334,15 @@ 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 capture mode.
+   * Programmatically set the component to idle mode.
    * ```js
    * const coordinateConversionComponent = document.getElementsByTagName("arcgis-coordinate-conversion")[0];
-   * coordinateConversionComponent.mode = "capture";
+   * coordinateConversionComponent.mode = "idle";
    * ```
    */
   accessor mode: Mode;
@@ -304,6 +356,7 @@ 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;
@@ -313,6 +366,22 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
    */
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /**
+   * Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.
+   * When false: 01.37°N, 008.71°E
+   * When true: 1.37°N, 8.71°E
+   *
+   * @default false
+   * @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.
    *
@@ -335,6 +404,14 @@ export abstract class ArcgisCoordinateConversion extends LitElement {
    * @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.
@@ -359,7 +436,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" | "expanded" | "mode"; }>;
+  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "currentLocation" | "state" | "mode" | "verticalUnit"; }>;
   /** 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": {