Class: Overlay

Extends

• PSV.components.AbstractComponent

Members

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

All child components

container HTMLElement readonly inherited overrides

parent PSV.Viewer | PSV.components.AbstractComponent readonly inherited overrides

prop Object protected inherited overrides

Internal properties

Properties:

Name	Type	Description
contentId	string
dissmisable	boolean

psv PSV.Viewer readonly inherited overrides

Reference to main controller

Methods

destroy () protected inherited overrides

Destroys the component

hide (id) overrides

Hides the overlay

Name	Type	Description
id	string	optional

Fires:

• PSV.event:hide-overlay

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 an overlay on the viewer

Name	Type	Description
config	Object | string	Name Type Default Description id string optional unique identifier to use with "hide" image string SVG image/icon displayed above the text text string main message subtext string optional secondary message dissmisable boolean true optional if the user can hide the overlay by clicking

Fires:

• PSV.event:show-overlay

toggle (visible) inherited overrides

This method is not supported

Name	Type	Description
visible	boolean	optional forced state

Throws:

always

Type

PSV.PSVError