Class Plugin<PluginEvents> Abstract

Base plugin class.

Type Parameters

PluginEvents extends Record<string, unknown> = {}

Hierarchy

Event<PluginEvents>
- Plugin

Index

Constructors

constructor

Properties

id

Methods

destroy

Constructors

constructor

new Plugin<PluginEvents>(viewer: BaseViewer, cfg: PluginConfig): Plugin<PluginEvents>

Overrides Event<PluginEvents>.constructor
- Defined in core/viewers/Plugin.ts:29
Creates this Plugin and installs it into the given {@link Viewer}.

Type Parameters
- PluginEvents extends Record<string, unknown> = {}
Parameters
- viewer: BaseViewer
  
  The viewer.
- cfg: PluginConfig
Returns Plugin<PluginEvents>

Properties

Readonly id

id: string

Methods

destroy

destroy(): void

- Defined in core/viewers/Plugin.ts:42
Destroys this Plugin and removes it from its viewer.

Returns void

Generated using TypeDoc