Class Overlay

Overlay component

Hierarchy (View Summary)

AbstractComponent
- Overlay

Index

Properties

container parent viewer

Methods

hide isVisible show

Properties

`Readonly`container

container: HTMLElement

Container element

`Protected` `Readonly`parent

parent: Viewer | AbstractComponent

`Protected` `Readonly`viewer

viewer: Viewer

Reference to main controller

Methods

hide

hide(id?: string): void
Hides the overlay
Parameters
- Optionalid: string
Returns void
Overrides AbstractComponent.hide
- Defined in packages/core/src/components/Overlay.ts:140

isVisible

isVisible(id?: string): boolean
Checks if the overlay is visible
Parameters
- Optionalid: string
Returns boolean
Overrides AbstractComponent.isVisible
- Defined in packages/core/src/components/Overlay.ts:106

show

show(config: string | OverlayConfig): void
Displays an overlay on the viewer
Parameters
- config: string | OverlayConfig
Returns void
Overrides AbstractComponent.show
- Defined in packages/core/src/components/Overlay.ts:121