@arcgis/map-components/dist/components/arcgis-home/customElement.d.ts

ArcGIS Map Components

/// <reference path="../../index.d.ts" />
import type Viewpoint from "@arcgis/core/Viewpoint.js";
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";
import type { ArcgisReferenceElement, GoToOverride, IconName } from "../types.js";
import type { T9nMeta } from "@arcgis/lumina/controllers";
import type { Button as Button } from "@esri/calcite-components/components/calcite-button";

/**
 * The Home component is a button that navigates back to the
 * initial [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)
 * or a previously defined `viewpoint`.
 *
 * @since 4.28
 * @example
 * ```js
 * // Create viewpoint centered on extent of a polygon geometry
 *
 * let vp = new Viewpoint({
 *   targetGeometry: geom.extent
 * });
 *
 * // Sets the Home's viewpoint to that Viewpoint
 * home.viewpoint = vp;
 * ```
 */
export abstract class ArcgisHome 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/components/arcgis-home/#destroy) method when you are done to
   * prevent memory leaks.
   *
   * @default false
   */
  accessor autoDestroyDisabled: boolean;
  /**
   * This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.
   *
   * @since 4.33
   * @example
   * ```js
   * component.goToOverride = function(view, goToParams) {
   *   goToParams.options = {
   *     duration: updatedDuration
   *   };
   *   return view.goTo(goToParams.target, goToParams.options);
   * };
   * ```
   */
  accessor goToOverride: GoToOverride | undefined;
  /**
   * Icon displayed in the component's button.
   *
   * @default "home"
   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
   */
  accessor icon: IconName | undefined;
  /** The component's default label. */
  accessor label: string | undefined;
  /**
   * Replace localized message strings with your own strings.
   *
   * _**Note**: Individual message keys may change between releases._
   */
  accessor messageOverrides: {
      componentLabel?: string | undefined;
      title?: string | undefined;
      cancel?: string | undefined;
  };
  /** @internal */
  protected messages: Partial<{
      componentLabel: string;
      title: string;
      cancel: string;
  }> & T9nMeta<{
      componentLabel: string;
      title: string;
      cancel: 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(): "disabled" | "going-home" | "ready";
  /**
   * 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-home component will be associated with a map or scene component rather than using the `view` property.
   */
  accessor view: MapView | SceneView | undefined;
  /**
   * The [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)
   * to go to when going "home".
   * The initial value is determined in a few different ways:
   *
   * If no `referenceElement` is provided, the value is `null`.
   * Once the `referenceElement` is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/).
   *
   * @example
   * ```js
   * // Create viewpoint centered on extent of a polygon geometry
   *
   * let viewpoint = new Viewpoint({
   *   targetGeometry: geom.extent
   * });
   *
   * // Sets the Home's viewpoint to that Viewpoint
   * home.viewpoint = viewpoint;
   * ```
   */
  accessor viewpoint: null | undefined | Viewpoint;
  /**
   * Specifies the size of the component.
   *
   * @default "m"
   * @since 5.0
   */
  accessor visualScale: Button["scale"];
  /**
   * This function provides the ability to interrupt and cancel the process
   * of navigating back to the initial extent.
   */
  cancelGo(): Promise<void>;
  /** Permanently destroy the component. */
  destroy(): Promise<void>;
  /**
   * Animates the map or scene to its initial Viewpoint or the
   * value of `viewpoint`.
   */
  go(): Promise<void>;
  /**
   * Fires when the go() method is called.
   *
   * @example
   * ```js
   * home.addEventListener("arcgisGo", (event) => {
   *   console.log("updating viewpoint");
   * });
   * ```
   */
  readonly arcgisGo: 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: "state" | "viewpoint"; }>;
  /** 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": {
    arcgisGo: ArcgisHome["arcgisGo"]["detail"];
    arcgisPropertyChange: ArcgisHome["arcgisPropertyChange"]["detail"];
    arcgisReady: ArcgisHome["arcgisReady"]["detail"];
  };
}