Interface Notification

Notification component

interface Notification {
    container: HTMLElement;
    parent: Viewer | AbstractComponent;
    viewer: Viewer;
    destroy(): void;
    hide(id?: string): void;
    isVisible(id?: string): boolean;
    show(config: string | NotificationConfig): void;
}

Hierarchy (View Summary)

AbstractComponent
- Notification

Index

Properties

container parent viewer

Methods

destroy 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

destroy

destroy(): void
Destroys the component

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

hide

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

isVisible

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

show

show(config: string | NotificationConfig): 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