Home > @jsplumbtoolkit/browser-ui-plugin-background > BackgroundPlugin
BackgroundPlugin class
Offers a means to manage backgrounds for a Surface.
Signature:
export declare class BackgroundPlugin implements SurfacePlugin
Implements: SurfacePlugin
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| type | static | string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| hide() | Sets the background to be invisible | |
| setUrl(url) | Sets the current image url. | |
| setVisible(v) | Sets the visible state of the background | |
| show() | Sets the background to be visible. | |
| toggle() | Toggles the visible state of the background. |