@arcgis/map-components
Version:
ArcGIS Map Components
73 lines (72 loc) • 3.1 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type LinkChartView from "@arcgis/core/views/LinkChartView.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 } from "../types.js";
import type { T9nMeta } from "@arcgis/lumina/controllers";
import type { Button as Button } from "@esri/calcite-components/components/calcite-button";
/**
* The Fullscreen component allows users to toggle the map or scene to fullscreen mode.
* Use the escape key (`esc`) to exit fullscreen mode.
*
* **Known limitations**
*
* * Fullscreen only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/docs/Web/API/Fullscreen_API) API.
* Thus, iOS Safari is not supported.
*
* @since 4.28
*/
export abstract class ArcgisFullscreen extends LitElement {
/** The [HTMLElement](https://developer.mozilla.org/docs/Web/API/HTMLElement) to present in fullscreen mode. */
get element(): Element | undefined;
set element(value: Element | 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;
enter?: string | undefined;
exit?: string | undefined;
};
/** @internal */
protected messages: Partial<{
componentLabel: string;
enter: string;
exit: string;
}> & T9nMeta<{
componentLabel: string;
enter: string;
exit: 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;
get state(): "active" | "disabled" | "ready" | "unsupported";
accessor view: LinkChartView | MapView | SceneView | undefined;
/**
* Specifies the size of the component.
*
* @default "m"
* @since 5.0
*/
accessor visualScale: Button["scale"];
"@setterTypes": {
element?: Element | string | undefined;
};
/** 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: ArcgisFullscreen["arcgisPropertyChange"]["detail"];
arcgisReady: ArcgisFullscreen["arcgisReady"]["detail"];
};
}