@arcgis/map-components/dist/components/arcgis-directional-pad/customElement.d.ts

ArcGIS Map Components

/// <reference path="../../index.d.ts" />
import type MapView from "@arcgis/core/views/MapView.js";
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { ArcgisReferenceElement } from "../types.js";
import type { T9nMeta } from "@arcgis/lumina/controllers";
import type { DirectionalPadViewModelState } from "@arcgis/core/widgets/DirectionalPad/DirectionalPadViewModel.js";
import type { Button as Button } from "@esri/calcite-components/components/calcite-button";

/**
 * A directional pad (D-Pad) component can be used to control the position and
 * rotation of the map. The D-Pad provides eight directions of movement, a small
 * compass which indicates the current orientation of the map and a slider for
 * rotating the map.
 *
 * It is also possible to disable the map's rotation controls or change the size
 * of the component.
 *
 * The Directional Pad component is not supported in 3D.
 *
 * @since 4.29
 */
export abstract class ArcgisDirectionalPad 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-directional-pad/#destroy) method when you are done to
   * prevent memory leaks.
   *
   * @default false
   */
  accessor autoDestroyDisabled: boolean;
  /**
   * When true, the component is visually withdrawn and cannot receive user interaction.
   *
   * @default false
   */
  accessor disabled: boolean;
  /**
   * Whether to hide directional pad buttons.
   *
   * @default false
   */
  accessor hideDirectionalButtons: boolean;
  /**
   * Icon which represents the component.
   * Typically used when the component is controlled by another component (e.g. by the Expand component).
   *
   * @default "move"
   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
   */
  accessor icon: string | 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;
      northWest?: string | undefined;
      north?: string | undefined;
      northEast?: string | undefined;
      east?: string | undefined;
      southEast?: string | undefined;
      south?: string | undefined;
      southWest?: string | undefined;
      west?: string | undefined;
      heading?: string | undefined;
      resetHeading?: string | undefined;
      unsupported?: string | undefined;
  };
  /** @internal */
  protected messages: Partial<{
      componentLabel: string;
      northWest: string;
      north: string;
      northEast: string;
      east: string;
      southEast: string;
      south: string;
      southWest: string;
      west: string;
      heading: string;
      resetHeading: string;
      unsupported: string;
  }> & T9nMeta<{
      componentLabel: string;
      northWest: string;
      north: string;
      northEast: string;
      east: string;
      southEast: string;
      south: string;
      southWest: string;
      west: string;
      heading: string;
      resetHeading: string;
      unsupported: 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;
  /**
   * Whether to display the button to reset the rotation angle. This only takes
   * effect if showRotationSlider is true.
   *
   * @default false
   */
  accessor showRotationResetButton: boolean;
  /**
   * Whether to display the map rotation slider.
   *
   * @default false
   */
  accessor showRotationSlider: boolean;
  /** The current state of the component. */
  get state(): DirectionalPadViewModelState;
  /**
   * 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-directional-pad component will be associated with a map or scene component rather than using the `view` property.
   */
  accessor view: MapView | null | undefined;
  /**
   * Determines the size of directional pad buttons and the slider.
   *
   * In addition to this parameter, you can set the width on the component
   * container to dictate directional pad size.
   *
   * @default "s"
   */
  accessor visualScale: Button["scale"];
  /** Permanently destroy the component. */
  destroy(): Promise<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"; }>;
  /** 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": {
    arcgisPropertyChange: ArcgisDirectionalPad["arcgisPropertyChange"]["detail"];
    arcgisReady: ArcgisDirectionalPad["arcgisReady"]["detail"];
  };
}