@arcgis/map-components 5.0.0-next.136 → 5.0.0-next.138

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

@@ -1,100 +1,102 @@
 /// <reference path="../../index.d.ts" />
-import { default as MapView } from '@arcgis/core/views/MapView.js';
-import { default as SceneView } from '@arcgis/core/views/SceneView.js';
-import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { ArcgisReferenceElement } from '../../utils/component-utils';
+import type MapView from "@arcgis/core/views/MapView.js";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina/PublicLitElement";
+import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { Button as Button } from "@esri/calcite-components/components/calcite-button";
 
-type Layout = "horizontal" | "vertical";
-type State = "disabled" | "ready";
 /**
  * The Zoom component allows users to zoom in/out within a map or scene.
  *
- * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-zoom/)
- *
  * @since 4.28
  */
-export declare class ArcgisZoom 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 Zoom component will be associated with a map or scene component rather than using the `view` property.
-     */
-    view?: MapView | 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
-     * 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-zoom/#destroy) method when you are done to
-     * prevent memory leaks.
-     *
-     * @default false
-     */
-    autoDestroyDisabled: boolean;
-    /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     *
-     * @default "magnifying-glass-plus"
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     */
-    icon?: string;
-    /** The component's default label. */
-    label?: string;
-    /**
-     * Determines the layout/orientation of the Zoom component.
-     *
-     * @default "vertical"
-     */
-    layout: Layout;
-    /**
-     * Replace localized message strings with your own strings.
-     *
-     * _**Note**: Individual message keys may change between releases._
-     */
-    messageOverrides?: typeof this.messages._overrides;
-    /**
-     * 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;
-    /**
-     * Specifies the size of the component.
-     *
-     * @default "m"
-     * @since 5.0
-     */
-    visualScale: HTMLCalciteButtonElement["scale"];
-    /** The current state of the component. */
-    get state(): State;
-    /** Permanently destroy the component. */
-    destroy(): Promise<void>;
-    /** Zooms the view in by an LOD factor of 0.5. */
-    zoomIn(): Promise<void>;
-    /** Zooms the view out by an LOD factor of 2. */
-    zoomOut(): Promise<void>;
-    /** Emitted when one of the zoom controls is clicked. */
-    readonly arcgisClick: TargetedEvent<this, {
-        action: "zoomIn" | "zoomOut";
-    }>;
-    /** 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>;
-    private messages: Partial<{
-        componentLabel: string;
-        zoomIn: string;
-        zoomOut: string;
-    }> & import('@arcgis/lumina/controllers').T9nMeta<{
-        componentLabel: string;
-        zoomIn: string;
-        zoomOut: string;
-    }>;
-    "@eventTypes": {
-        "arcgisClick": ArcgisZoom["arcgisClick"]["detail"];
-        "arcgisPropertyChange": ArcgisZoom["arcgisPropertyChange"]["detail"];
-        "arcgisReady": ArcgisZoom["arcgisReady"]["detail"];
-    };
+export abstract class ArcgisZoom extends LitElement {
+  /**
+   * 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-zoom/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   */
+  accessor autoDestroyDisabled: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @default "magnifying-glass-plus"
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: string | undefined;
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /**
+   * Determines the layout/orientation of the Zoom component.
+   *
+   * @default "vertical"
+   */
+  accessor layout: Layout;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
+  accessor messageOverrides: {
+      componentLabel?: string | undefined;
+      zoomIn?: string | undefined;
+      zoomOut?: string | undefined;
+  };
+  /** @internal */
+  protected messages: Partial<{
+      componentLabel: string;
+      zoomIn: string;
+      zoomOut: string;
+  }> & T9nMeta<{
+      componentLabel: string;
+      zoomIn: string;
+      zoomOut: string;
+  }>;
+  /**
+   * 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)
+   */
+  accessor referenceElement: ArcgisReferenceElement | string | undefined;
+  /** The current state of the component. */
+  get state(): State;
+  /**
+   * 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 Zoom component will be associated with a map or scene component rather than using the `view` property.
+   */
+  accessor view: MapView | SceneView | undefined;
+  /**
+   * Specifies the size of the component.
+   *
+   * @default "m"
+   * @since 5.0
+   */
+  accessor visualScale: Button["scale"];
+  /** Permanently destroy the component. */
+  destroy(): Promise<void>;
+  /** Zooms the view in by an LOD factor of 0.5. */
+  zoomIn(): Promise<void>;
+  /** Zooms the view out by an LOD factor of 2. */
+  zoomOut(): Promise<void>;
+  /** Emitted when one of the zoom controls is clicked. */
+  readonly arcgisClick: import("@arcgis/lumina").TargetedEvent<this, { action: "zoomIn" | "zoomOut"; }>;
+  /** 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: "state"; }>;
+  /** 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": {
+    arcgisClick: ArcgisZoom["arcgisClick"]["detail"];
+    arcgisPropertyChange: ArcgisZoom["arcgisPropertyChange"]["detail"];
+    arcgisReady: ArcgisZoom["arcgisReady"]["detail"];
+  };
 }
-export {};
+
+export type Layout = "horizontal" | "vertical";
+
+export type State = "disabled" | "ready";

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

@@ -9,7 +9,7 @@ import { u as x } from "../../chunks/useT9n.js";
 import { u as $ } from "../../chunks/useView.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.136 */
+v5.0.0-next.138 */
 const i = {
   base: "arcgis-zoom",
   button: "arcgis-button",

package/dist/components/arcgis-zoom/index.d.ts

@@ -1,2 +1 @@
-import "@esri/calcite-components/components/calcite-button";
 export * from "./customElement.js";

package/dist/components/support/goTo.d.ts

@@ -1,28 +1,36 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-import { GoToOptions2D, GoToOptions3D, GoToTarget2D, GoToTarget3D } from '@arcgis/core//views/types.js';
+import type { GoToOptions2D, GoToOptions3D, GoToTarget2D, GoToTarget3D } from "@arcgis/core//views/types.js";
+
+/**
+ * @param view
+ * @param goToParameters
+ */
+export type GoToOverride = (view: GoToOwner & MapViewOrSceneView, goToParameters: GoToParameters) => Promise<void>;
+
+export type GoToOwner = Pick<__esri.MapView, "goTo">
+  & Pick<__esri.SceneView, "goTo">;
+
+export type MapViewOrSceneView = __esri.MapView | __esri.SceneView;
+
+export type GoToParameters = GoToParameters2D
+  & GoToParameters3D;
+
 export interface GoToParameters2D {
-    /**
-     * The target location/viewpoint/extent to animate to.
-     *
-     * @public
-     * @since 5.0
-     */
-    target: GoToTarget2D;
-    /**
-     * Options defining the animation and duration of the navigation.
-     *
-     * @public
-     * @since 5.0
-     */
-    options?: GoToOptions2D;
+  /**
+   * The target location/viewpoint/extent to animate to.
+   *
+   * @since 5.0
+   */
+  target: GoToTarget2D;
+  /**
+   * Options defining the animation and duration of the navigation.
+   *
+   * @since 5.0
+   */
+  options?: GoToOptions2D;
 }
+
 export interface GoToParameters3D {
-    target: GoToTarget3D;
-    options?: GoToOptions3D;
-}
-export type GoToOwner = Pick<__esri.MapView, "goTo"> & Pick<__esri.SceneView, "goTo">;
-type MapViewOrSceneView = __esri.MapView | __esri.SceneView;
-export type GoToOverride = (view: GoToOwner & MapViewOrSceneView, goToParameters: GoToParameters) => Promise<void>;
-export type GoToParameters = GoToParameters2D & GoToParameters3D;
-export declare function callGoTo(params: GoToParameters, view: __esri.MapView | __esri.SceneView, goToOverride?: GoToOverride): Promise<void>;
-export {};
+  target: GoToTarget3D;
+  options?: GoToOptions3D;
+}

package/dist/components/types.d.ts

@@ -1,5 +1 @@
-export type MeasurementSystem = "imperial" | "metric";
-type MetricMapUnit = "centimeter" | "kilometer" | "meter" | "millimeter";
-type ImperialMapUnit = "foot" | "inch" | "mile";
-export type MapUnit = ImperialMapUnit | MetricMapUnit;
-export {};
+export type MeasurementSystem = "imperial" | "metric";

package/dist/controllers/useArcgisLoadError.d.ts

@@ -1,27 +1,9 @@
-import { default as WebMap } from '@arcgis/core/WebMap.js';
-import { default as WebScene } from '@arcgis/core/WebScene.js';
-import { default as WebLinkChart } from '@arcgis/core/WebLinkChart';
-import { default as Map } from '@arcgis/core/Map.js';
-import { default as Basemap } from '@arcgis/core/Basemap.js';
-import { default as Ground } from '@arcgis/core/Ground.js';
-import { default as Layer } from '@arcgis/core/layers/Layer.js';
-import { EventEmitter } from '@arcgis/lumina';
+import type WebMap from "@arcgis/core/WebMap.js";
+import type WebScene from "@arcgis/core/WebScene.js";
+import type WebLinkChart from "@arcgis/core/WebLinkChart";
+import type Basemap from "@arcgis/core/Basemap.js";
+import type Ground from "@arcgis/core/Ground.js";
+import type Layer from "@arcgis/core/layers/Layer.js";
+
 /** A potential source of load errors. */
-export type LoadErrorSource = Basemap | Ground | Layer | WebLinkChart | WebMap | WebScene;
-/**
- * Watches for load errors on components that have a `map` property. Returns an event that will be
- * emitted each time a load error is thrown. It will also update the component's `loadErrorSources`
- * property with the latest errors.
- *
- * @example
- *
- * ```js
- * class MyMapComponent extends LitElement {
- *   arcgisLoadError = useArcgisLoadError(this);
- * }
- * ```
- */
-export declare const useArcgisLoadError: (component: {
-    map: Map | nullish;
-    loadErrorSources?: LoadErrorSource[];
-} & import('@arcgis/lumina').LitElement) => EventEmitter;
+export type LoadErrorSource = Basemap | Ground | Layer | WebLinkChart | WebMap | WebScene;