Skip to main content

Class: ContentHighlight

Defined in: index.ts:42

A plugin that highlights the area where content exists on the workspace.

Properties index​

PropertyDescription
workspaceThe workspace that the plugin will be added to.

Methods index​

MethodDescription
disposeDisposes of content highlight. Unlinks from all DOM elements and remove all event listeners to prevent memory leaks.
initInitializes the plugin.

Constructors​

Constructor​

new ContentHighlight(workspace): ContentHighlight;

Defined in: index.ts:88

Constructor for the content highlight plugin.

Parameters​

ParameterTypeDescription
workspaceWorkspaceSvgThe 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​

ParameterTypeDescription
padding?numberThe padding to use for the content area highlight rectangle, in workspace units.

Returns​

void