Class BackgroundPlugin

Offers a means to manage backgrounds for a Surface.

Implements

SurfacePlugin

Index

Methods

hide setUrl setVisible show toggle

Methods

hide

hide(): void
Sets the background to be invisible

Returns void

setUrl

setUrl(url): void
Sets the current image url.
Parameters
- url: string
Returns void

setVisible

setVisible(v): void
Sets the visible state of the background
Parameters
- v: boolean
Returns void

show

show(): void
Sets the background to be visible.

Returns void

toggle

toggle(): void
Toggles the visible state of the background.

Returns void