Class Notification

Notification component

Hierarchy

AbstractComponent
- Notification

Index

Properties

container parent viewer

Methods

destroy hide isVisible show

Properties

`Readonly` container

container: HTMLDivElement = ...

Container element

`Protected` `Readonly` parent

parent: Viewer | AbstractComponent

`Protected` `Readonly` viewer

viewer: Viewer

Reference to main controller

Methods

destroy

destroy(): void
Destroys the component

Returns void
Inherited from AbstractComponent.destroy
- Defined in packages/core/src/components/AbstractComponent.ts:46

hide

hide(id?): void
Hides the notification
Parameters
- Optional id: string
  Optional
Returns void
Overrides AbstractComponent.hide
- Defined in packages/core/src/components/Notification.ts:103

isVisible

isVisible(id?): boolean
Checks if the notification is visible
Parameters
- Optional id: string
  Optional
Returns boolean
Overrides AbstractComponent.isVisible
- Defined in packages/core/src/components/Notification.ts:57

show

show(config): void
Displays a notification on the viewer
Parameters
- config: string | NotificationConfig
Returns void
Example
```
viewer.showNotification({ content: 'Hello world', timeout: 5000 })
```
Example
```
viewer.showNotification('Hello world')
```
Overrides AbstractComponent.show
- Defined in packages/core/src/components/Notification.ts:77

Generated using TypeDoc