import "@arcgis/map-components/components/arcgis-video";The ArcGIS Video component provides a view for displaying video feeds from a VideoLayer. It is designed to render and interact with video layers.
A Video component must have a valid VideoLayer. It supports various features such as navigating, zooming, and panning, making it suitable for applications that require interactive video overlays.
Properties
autoDestroyDisabled
autoDestroyDisabled: boolean- Attribute
- auto-destroy-disabled
- Default value
- false
ready
ready: booleanWhen true, this property indicates whether the view successfully satisfied all dependencies,
signaling that the following conditions are met.
- Default value
- false
view
view: VideoViewThe VideoView instance created and manged by the component. Accessible once the component is fully loaded.
Slots
Events
| Event | Type |
|---|---|
CustomEvent<void> |
arcgisViewReadyChange
arcgisViewReadyChange: CustomEvent<void>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> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisVideo = document.querySelector("arcgis-video");
document.body.append(arcgisVideo);
await arcgisVideo.componentOnReady();
console.log("arcgis-video is ready to go!");- Returns
- Promise<void>