@arcgis/map-components 5.0.0-next.6 → 5.0.0-next.61

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

@@ -12,7 +12,7 @@ import { View, AlertProperties, Orientation, StorageType } from './interfaces';
 
 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 +33,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?: nullish | __esri.MapView | __esri.SceneView;
     /**
      * 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,8 +61,8 @@ 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"];
      * ```
      */
@@ -73,22 +73,22 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      *
      * @type {Point}
      * @example
-     * Set the current location
-     * ```ts
+     * Set the current location.
+     * ```js
      * coordinateConversionComponent.currentLocation = { x: 77.0369, y: 38.9072, spatialReference: { wkid: 4326 } };
      * ```
      */
     currentLocation?: Point | nullish;
     /**
-     * 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,15 +99,15 @@ 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);
@@ -130,69 +130,64 @@ export declare class ArcgisCoordinateConversion extends LitElement {
      * 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;
     /**
@@ -213,12 +208,12 @@ 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" };
      * ```
@@ -231,25 +226,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";
     /**
-     * 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 +265,22 @@ 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: "ready" | "disabled" | "loading";
     /**
      * 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"
      */
     storageType: StorageType;
     /** Permanently destroy the component. */
@@ -296,15 +290,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>;