import "@arcgis/map-components/components/arcgis-fullscreen";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
- The Fullscreen widget only works with browsers that implement the Fullscreen API. Thus, iOS Safari is not supported.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
element | Element | string | |
label | string | |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
statereadonly | state | "active" | "disabled" | "ready" | "unsupported" |
element
element: Element | stringThe HTMLElement to present in fullscreen mode.
- Attribute
- element
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "top-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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.
- Attribute
- reference-element
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisFullscreen = document.querySelector("arcgis-fullscreen");
document.body.append(arcgisFullscreen);
await arcgisFullscreen.componentOnReady();
console.log("arcgis-fullscreen is ready to go!");- Returns
- Promise<void>