Class: ContentHighlight
Defined in: index.ts:42
A plugin that highlights the area where content exists on the workspace.
Properties index
| Property | Description |
|---|---|
| workspace | The workspace that the plugin will be added to. |
Methods index
| Method | Description |
|---|---|
| dispose | Disposes of content highlight. Unlinks from all DOM elements and remove all event listeners to prevent memory leaks. |
| init | Initializes the plugin. |
Constructors
Constructor
new ContentHighlight(workspace): ContentHighlight;
Defined in: index.ts:88
Constructor for the content highlight plugin.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspace | WorkspaceSvg | The workspace that the plugin will be added to. |
Returns
ContentHighlight
Properties
workspace
protected workspace: WorkspaceSvg;
Defined in: index.ts:88
The workspace that the plugin will be added to.
Methods
dispose()
dispose(): void;
Defined in: index.ts:174
Disposes of content highlight. Unlinks from all DOM elements and remove all event listeners to prevent memory leaks.
Returns
void
init()
init(padding?): void;
Defined in: index.ts:96
Initializes the plugin.
Parameters
| Parameter | Type | Description |
|---|---|---|
padding? | number | The padding to use for the content area highlight rectangle, in workspace units. |
Returns
void