@arcgis/map-components
Version:
ArcGIS Map Components
65 lines (63 loc) • 2.86 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/components-controllers';
import { Nil } from '@arcgis/components-utils';
import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { PropertyValues } from 'lit';
import { useView } from '../../controllers/useView';
import { ArcgisReferenceElement } from '../../utils/component-utils';
type State = "disabled" | "ready";
type NavigationMode = "pan" | "rotate";
type LayoutMode = "horizontal" | "vertical";
/**
* 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.
*
* The Navigation Toggle component is only supported in 3D.
*/
export declare class ArcgisNavigationToggle 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\` method when you are done to prevent
* memory leaks.
*/
autoDestroyDisabled: boolean;
/**
* Icon which represents the component. It is typically used when the
* component is controlled by another one (e.g. in the arcgis-expand
* component).
*
* @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
*/
icon: HTMLCalciteIconElement["icon"] | Nil;
/** The component's default label. */
label: string | undefined;
/** The layout direction of the component. */
layout: LayoutMode;
/**
* The navigation mode of the view. See the table below for a list of
* possible values.
*
* Possible Value | Description
* ---------------|-------------
* 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.
*/
navigationMode: NavigationMode;
position: __esri.UIPosition;
referenceElement: ArcgisReferenceElement | Nil | string;
state: State;
/** Permanently destroy the component */
destroy(): Promise<void>;
toggle(): Promise<void>;
readonly arcgisPropertyChange: TargetedEvent<this, {
name: "state" | "layout";
}>;
readonly arcgisReady: TargetedEvent<this, undefined>;
}
export {};