@arcgis/map-components
Version:
ArcGIS Map Components
56 lines (55 loc) • 2.7 kB
TypeScript
/// <reference path="../../index.d.ts" />
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 { EsriClipboard } from "@arcgis/core/applications/Components/clipboard.js";
import type { ArcgisReferenceElement } from "../types.js";
import type { T9nMeta } from "@arcgis/lumina/controllers";
/**
* The Feature Clipboard displays the current contents of the clipboard.
*
* @since 5.0
* @internal
*/
export abstract class ArcgisClipboard extends LitElement {
/** @internal */
protected _messages: Partial<{
clipboardContents: string;
clipboardDataItem: string;
removeClipboardItem: string;
noClipboardData: string;
tooManyClipboardItems: string;
}> & T9nMeta<{
clipboardContents: string;
clipboardDataItem: string;
removeClipboardItem: string;
noClipboardData: string;
tooManyClipboardItems: string;
}>;
/** Access the application clipboard */
get clipboard(): EsriClipboard;
/**
* Indicates whether to display tooltips on clipboard items.
*
* @default false
*/
accessor hideTooltips: boolean;
/** @default 100 */
accessor maxShowCount: number;
/**
* 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 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-clipboard component will be associated with a map or scene component rather than using the `view` property.
*/
accessor view: MapView | SceneView | undefined;
/** 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": {
arcgisReady: ArcgisClipboard["arcgisReady"]["detail"];
};
}