Class AbstractPlugin<TEvents>`Abstract`

Base class for plugins

Type Parameters

TEvents extends TypedEvent<AbstractPlugin> = never

union of dispatched events

Hierarchy

TypedEventTarget<TEvents>
- AbstractPlugin
  - AbstractConfigurablePlugin

Index

Constructors

Properties

viewer VERSION id

Methods

addEventListener destroy dispatchEvent init removeEventListener

Constructors

constructor

new AbstractPlugin<TEvents>(viewer): AbstractPlugin<TEvents>
Type Parameters
- TEvents extends TypedEvent<AbstractPlugin<never>> = never
Parameters
- viewer: Viewer
Returns AbstractPlugin<TEvents>
Overrides TypedEventTarget.constructor
- Defined in packages/core/src/plugins/AbstractPlugin.ts:22

Properties

`Protected` viewer

viewer: Viewer

`Static` `Readonly` VERSION

VERSION: string

Expected version of the core DO NOT USE on custom plugins

`Static` `Readonly` id

id: string

Unique identifier of the plugin

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends string
  
  the name of event
- E extends TypedEvent<AbstractPlugin<never>> & {
  type: T;
  }
  
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | AddEventListenerOptions
  Optional
Returns void
Inherited from TypedEventTarget.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

destroy

destroy(): void
Destroys the plugin

Returns void
- Defined in packages/core/src/plugins/AbstractPlugin.ts:36

dispatchEvent

dispatchEvent(e): boolean
Parameters
- e: TEvents
Returns boolean
Inherited from TypedEventTarget.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

init

init(): void
Initializes the plugin

Returns void
- Defined in packages/core/src/plugins/AbstractPlugin.ts:30

removeEventListener

removeEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends string
  
  the name of event
- E extends TypedEvent<AbstractPlugin<never>> & {
  type: T;
  }
  
  the class of the event
Parameters
- type: TEvents["type"]
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | EventListenerOptions
  Optional
Returns void
Inherited from TypedEventTarget.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

Generated using TypeDoc