@arcgis/map-components 4.34.0-next.133 → 4.34.0-next.135

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

@@ -18,29 +18,82 @@ declare const useLocateViewModel: (component: LitElement & Pick<LocateViewModel,
  * @since 4.28
  */
 export declare class ArcgisLocate 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 ArcgisLocate component will be associated with a map or scene component rather than using the `view` property.
+     */
     view?: __esri.MapView | __esri.SceneView | 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
+     * component to a different place on the page, or temporarily hide it. If this
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
     autoDestroyDisabled: boolean;
     geolocationOptions: PositionOptions | undefined;
+    /**
+     * Indicates whether to navigate the view to the position and scale of the geolocated result.
+     *
+     * @default false
+     */
     goToLocationDisabled: boolean;
     goToOverride: __esri.GoToOverride | undefined;
+    /** The graphic used to show the user's location on the map. */
     graphic: __esri.Graphic;
+    /**
+     * 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/)
+     * @default "gps-off"
+     */
     icon?: string | undefined;
+    /** The component's default label. */
     label?: string;
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this.messages._overrides;
+    /** @default false */
     popupDisabled: boolean;
+    /** @deprecated since 4.34, use `slot` 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.
+     *
+     * @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)
+     */
     referenceElement?: ArcgisReferenceElement | string;
+    /**
+     * Indicates the scale to set on the view when navigating to the position of the geolocated
+     * result, after a location is returned from the [track](#event-track) event.
+     *
+     * @default null
+     */
     scale: number | undefined;
+    /** The current state of the component. */
     state: "ready" | "disabled" | "error" | "feature-unsupported" | "locating";
+    /**
+     * This function provides the ability to interrupt and cancel the process of
+     * programmatically obtaining the location of the user's device.
+     */
     cancelLocate(): Promise<void>;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     locate(): Promise<GeolocationPosition | null>;
     readonly arcgisError: TargetedEvent<this, {
         error: GeolocationPositionError;
     }>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
     readonly arcgisSuccess: TargetedEvent<this, {
         position: GeolocationPosition;

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

@@ -2,7 +2,7 @@ import { c as _ } from "../../chunks/runtime.js";
 import { css as G, html as g } from "lit";
 import { usePropertyChange as z } from "@arcgis/lumina/controllers";
 import { classes as F } from "@arcgis/toolkit/dom";
-import { watch as y } from "@arcgis/core/core/reactiveUtils.js";
+import { watch as v } from "@arcgis/core/core/reactiveUtils.js";
 import { LitElement as j, createEvent as f, safeClassMap as w, nothing as k } from "@arcgis/lumina";
 import { u as Q } from "../../chunks/useT9n.js";
 import { createRef as V, ref as H } from "lit/directives/ref.js";
@@ -27,8 +27,8 @@ import ie from "@arcgis/core/rest/support/ProjectParameters.js";
 import { g as re } from "../../chunks/globalCss.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.133 */
-const ae = G`.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:1.3em;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)}`;
+v4.34.0-next.135 */
+const ae = G`.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)}`;
 let E = !1;
 const se = {
   maximumAge: 0,
@@ -116,12 +116,12 @@ async function ge(e) {
   }
   return t.helperServices?.geometry?.url;
 }
-var fe = Object.defineProperty, ye = Object.getOwnPropertyDescriptor, p = (e, t, o, r) => {
-  for (var i = r > 1 ? void 0 : r ? ye(t, o) : t, a = e.length - 1, s; a >= 0; a--)
+var fe = Object.defineProperty, ve = Object.getOwnPropertyDescriptor, p = (e, t, o, r) => {
+  for (var i = r > 1 ? void 0 : r ? ve(t, o) : t, a = e.length - 1, s; a >= 0; a--)
     (s = e[a]) && (i = (r ? s(t, o, i) : s(i)) || i);
   return r && i && fe(t, o, i), i;
 };
-const ve = 2500;
+const ye = 2500;
 function x(e) {
   const t = {
     type: "CIMVectorMarker",
@@ -272,7 +272,7 @@ let c = class extends Z {
   //#region Lifecycle
   initialize() {
     le() || (this._geolocationUsable = !1), this.addHandles([
-      y(
+      v(
         () => this.view?.type,
         () => this._handleViewTypeChange(),
         {
@@ -313,7 +313,7 @@ let c = class extends Z {
     return e;
   }
   _getScale(e) {
-    const { scale: t } = this, o = typeof t == "number" ? t : ve;
+    const { scale: t } = this, o = typeof t == "number" ? t : ye;
     return this._getScaleWithinConstraints(o, e);
   }
   _getHeading(e, t) {
@@ -351,19 +351,19 @@ let c = class extends Z {
   }
   async updatePosition(e, t) {
     try {
-      const o = this.view, r = await de({ position: e, view: o }, { signal: t.signal }), { graphic: i } = this, { timestamp: a, coords: s } = e, { accuracy: m, altitude: h, altitudeAccuracy: L, latitude: N, longitude: D, speed: R } = s, v = this._getHeading(e, o), U = {
+      const o = this.view, r = await de({ position: e, view: o }, { signal: t.signal }), { graphic: i } = this, { timestamp: a, coords: s } = e, { accuracy: m, altitude: h, altitudeAccuracy: L, latitude: N, longitude: D, speed: R } = s, y = this._getHeading(e, o), U = {
         timestamp: a,
         accuracy: m,
         altitude: h,
         altitudeAccuracy: L,
-        heading: v,
+        heading: y,
         latitude: N,
         longitude: D,
         speed: R
       };
       i && (i.geometry = r, i.attributes = U);
       const I = this._getScale(o);
-      await this._animatePoint(r, I, v, t);
+      await this._animatePoint(r, I, y, t);
     } catch (o) {
       if (!S(o))
         throw new u("geolocation-positioning:invalid-point", "Cannot position invalid point", {
@@ -593,10 +593,10 @@ class Te extends j {
   }
   loaded() {
     this.viewModel.messages = { ...this.messages, ...this.messageOverrides }, this.manager.onLifecycle(() => [
-      y(() => this.viewModel.error, (t) => {
+      v(() => this.viewModel.error, (t) => {
         this.isErrorTooltipOpen = !!t, this.arcgisError.emit({ error: t });
       }),
-      y(() => this.viewModel.currentPosition, (t) => {
+      v(() => this.viewModel.currentPosition, (t) => {
         this.arcgisSuccess.emit({ position: t });
       })
     ]);