Notification component
Name | Type | Description |
---|---|---|
psv |
PSV.Viewer |
Extends
Members
-
children Array.<PSV.components.AbstractComponent> packagereadonly inherited overrides
All child components
-
-
-
parent PSV.Viewer | PSV.components.AbstractComponent readonly inherited overrides
-
-
Internal properties
-
Properties:
Name Type Description timeout
* -
psv PSV.Viewer readonly inherited overrides
Reference to main controller
-
Methods
-
Destroys the component
-
-
hide (id) overrides
Hides the notification
-
Name Type Description id
string optional Fires:
-
Checks if the component is visible
-
Name Type Description id
string optional Returns:
Type Description boolean -
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')
-
This method is not supported
-
Name Type Description visible
boolean optional forced state
Throws:
-
always
- Type
- PSV.PSVError
-