import "@arcgis/map-components/components/arcgis-fullscreen";
Provides a simple component to present the View or a user-defined HTMLElement using the entire screen
Demo
Properties
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
| HTMLElement | |
icon | string | |
label | string | |
| {
componentLabel?: string | undefined;
enter?: string | undefined;
exit?: string | undefined;
} | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
state readonly | state | "active" | "disabled" | "feature-unsupported" | "ready" |
autoDestroyDisabled
autoDestroyDisabled: boolean
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.
- Attribute
- auto-destroy-disabled
- Default value
- false
icon
icon: string
Icon displayed in the component's button. Search Calcite Icons for possible values.
- Attribute
- icon
- Default value
- "zoom-out-fixed"
messageOverrides
messageOverrides: {
componentLabel?: string | undefined;
enter?: string | undefined;
exit?: string | undefined;
}
Replace localized message strings with your own strings.
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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
state
state: "active" | "disabled" | "feature-unsupported" | "ready"
The current state of the component.
- Attribute
- state
- Default value
- "disabled"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state"; } | |
undefined |