Class: Overlay

PSV.components~Overlay

new Overlay (psv)

Overlay class

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
contentId string
dissmisable boolean

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

Check 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
image string
text string
subtext string optional
dissmisable boolean true optional
Fires:
  • PSV.event:show-overlay
Example
viewer.showOverlay({
  image: '',
  text: '....',
  subtext: '....'
})

toggle () inherited overrides

Displays or hides the component