Class: Notification

PSV.components.Notification

new PSV.components.Notification (psv)

Notification component

Name Type Description
psv PSV.Viewer

Extends

Members

children Array.<PSV.components.AbstractComponent> packagereadonly inherited overrides

All child components

container HTMLElement readonly inherited overrides

prop Object protected inherited overrides

Internal properties

Properties:
Name Type Description
timeout *

Reference to main controller

Methods

destroy () protected inherited overrides

Destroys the component

hide (id) overrides

Hides the notification

Name Type Description
id string optional
Fires:

isVisible (id)boolean inherited overrides

Checks if the component is visible

Name Type Description
id string optional
Returns:
Type Description
boolean

refreshUi () package inherited overrides

Refresh UI

Must be be a very lightweight operation

show (config) overrides

Displays a notification on the viewer

Name Type Description
config Object | string
Name Type Description
id string optional

unique identifier to use with "hide"

content string
timeout number optional
Fires:
Examples
viewer.showNotification({ content: 'Hello world', timeout: 5000 })
viewer.showNotification('Hello world')

toggle (visible) inherited overrides

This method is not supported

Name Type Description
visible boolean optional

forced state

Throws:

always

Type
PSV.PSVError