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

/**
 * The Navigation Toggle component can be used to control the navigation mode of a Scene component.
 *
 * When the navigation mode is set to "pan" (default), the mouse drag gesture pans the view and right-click + drag allows the user
 * to rotate the view. When the navigation mode is set to "rotate", the mouse drag gesture rotates the view and
 * right-click + drag pans the view.
 *
 * **Known limitations**
 *
 * Navigation Toggle is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.
 *
 *  \@since 4.28
 */
export abstract class ArcgisNavigationToggle extends LitElement {
  /** @internal */
  protected _messages: Partial<{
      componentLabel: string;
      pan: string;
      rotate: string;
  }> & T9nMeta<{
      componentLabel: string;
      pan: string;
      rotate: string;
  }>;
  /**
   * 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-navigation-toggle/#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).
   *
   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
   */
  accessor icon: Icon["icon"] | undefined;
  /** The component's default label. */
  accessor label: string | undefined;
  /**
   * The layout direction of the component.
   *
   * @default "vertical"
   */
  accessor layout: "horizontal" | "vertical";
  /**
   * Replace localized message strings with your own strings.
   *
   * _**Note**: Individual message keys may change between releases._
   */
  accessor messageOverrides: {
      componentLabel?: string | undefined;
      pan?: string | undefined;
      rotate?: string | undefined;
  };
  /**
   * The navigation mode of the view. The possible values:
   *
   * * `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.
   * * `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.
   *
   * @default "pan"
   */
  accessor navigationMode: "pan" | "rotate";
  /**
   * 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(): NavigationToggleState;
  /**
   * 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-navigation-toggle component will be associated with a map or scene component rather than using the `view` property.
   */
  accessor view: SceneView | undefined;
  /**
   * Specifies the size of the component.
   *
   * @default "m"
   * @since 5.0
   */
  accessor visualScale: Button["scale"];
  /** Permanently destroy the component. */
  destroy(): Promise<void>;
  toggle(): 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: "layout" | "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: ArcgisNavigationToggle["arcgisPropertyChange"]["detail"];
    arcgisReady: ArcgisNavigationToggle["arcgisReady"]["detail"];
  };
}