components.PSVOverlay

Members

---

<readonly> container :HTMLElement

Details

Type

HTMLElement

Inherited From

module:components.PSVComponent#container

Source

components/PSVComponent.js, line 28

---

<readonly> parent :PhotoSphereViewer|module:components.PSVComponent

Details

Type

PhotoSphereViewer | module:components.PSVComponent

Inherited From

module:components.PSVComponent#parent

Source

components/PSVComponent.js, line 22

---

<readonly> psv :PhotoSphereViewer

Details

Type

PhotoSphereViewer

Inherited From

module:components.PSVComponent#psv

Source

components/PSVComponent.js, line 16

---

<readonly> visible :boolean

Visibility of the component

Details

Type

boolean

Inherited From

module:components.PSVComponent#visible

Source

components/PSVComponent.js, line 35

Methods

---

<protected> create()

Creates the component

Details

Inherited From

module:components.PSVOverlay#create

Overrides

module:components.PSVComponent#create

Source

components/PSVOverlay.js, line 24

---

<protected> destroy()

Destroys the component

Details

Inherited From

module:components.PSVOverlay#destroy

Overrides

module:components.PSVComponent#destroy

Source

components/PSVOverlay.js, line 45

---

<protected> hide()

Hides the component

Details

Inherited From

module:components.PSVComponent#hide

Source

components/PSVComponent.js, line 95

---

hideOverlay()

Hides the notification

Fires

module:components.PSVOverlay.event:hide-notification

Details

Source

components/PSVOverlay.js, line 100

---

isOverlayVisible() → {boolean}

Checks if the overlay is visible

Returns

boolean

Details

Source

components/PSVOverlay.js, line 57

---

<protected> show()

Displays the component

Details

Inherited From

module:components.PSVComponent#show

Source

components/PSVComponent.js, line 104

---

showOverlay( config )

Displays an overlay on the viewer

Parameters

Name	Type	Description
config	Object | string	Name Type Description image string text string subtext string

Examples

viewer.showOverlay({
			  image: '<svg></svg>',
			  text: '....',
			  subtext: '....'
			})

Details

Source

components/PSVOverlay.js, line 75

Events

---

hide-overlay

Trigered when the overlay is hidden

Details

Source

components/PSVOverlay.js, line 104

---

show-overlay

Trigered when the overlay is shown

Details

Source

components/PSVOverlay.js, line 88