Class AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>`Abstract`

Base class for plugins with updatable configuration The implementation must have a static configParser property which is the result of utils.getConfigParser

Type Parameters

TConfig extends Record<string, any>

type of input config
TParsedConfig extends TConfig = TConfig

type of config after parsing
TUpdatableConfig extends TConfig = TConfig

type of config that can be updated
TEvents extends TypedEvent<AbstractPlugin> = never

union of dispatched events

Hierarchy

AbstractPlugin<TEvents>
- AbstractConfigurablePlugin

Index

Constructors

constructor

new AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>(viewer, config): AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>
Type Parameters
- TConfig extends Record<string, any>
- TParsedConfig extends Record<string, any> = TConfig
- TUpdatableConfig extends Record<string, any> = TConfig
- TEvents extends TypedEvent<AbstractPlugin<never>> = never
Parameters
- viewer: Viewer
- config: TConfig
Returns AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>
Overrides AbstractPlugin.constructor
- Defined in packages/core/src/plugins/AbstractPlugin.ts:59

Properties

`Readonly` config

config: TParsedConfig

`Protected` viewer

viewer: Viewer

`Static` `Readonly` VERSION

VERSION: string

Expected version of the core DO NOT USE on custom plugins

`Static` configParser

configParser: ConfigParser<any, any>

`Static` `Readonly` id

id: string

Unique identifier of the plugin

`Static` readonlyOptions

readonlyOptions: string[] = []

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 AbstractPlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

destroy

destroy(): void
Destroys the plugin

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

dispatchEvent

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

init

init(): void
Initializes the plugin

Returns void
Inherited from AbstractPlugin.init
- 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 AbstractPlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends string | number | symbol
Parameters
- option: T
- value: TUpdatableConfig[T]
Returns void
- Defined in packages/core/src/plugins/AbstractPlugin.ts:68

setOptions

setOptions(options): void
Update options
Parameters
- options: Partial<TUpdatableConfig>
Returns void
- Defined in packages/core/src/plugins/AbstractPlugin.ts:76

Class AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>Abstract

Type Parameters

TConfig extends Record<string, any>

TParsedConfig extends TConfig = TConfig

TUpdatableConfig extends TConfig = TConfig

TEvents extends TypedEvent<AbstractPlugin> = never

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TConfig extends Record<string, any>

TParsedConfig extends Record<string, any> = TConfig

TUpdatableConfig extends Record<string, any> = TConfig

TEvents extends TypedEvent<AbstractPlugin<never>> = never

Parameters

viewer: Viewer

config: TConfig

Returns AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>

Properties

Readonly config

Protected viewer

Static Readonly VERSION

Static configParser

Static Readonly id

Static readonlyOptions

Methods

addEventListener

Type Parameters

T extends string

E extends TypedEvent<AbstractPlugin<never>> & { type: T; }

Parameters

type: T

callback: EventListenerObject | ((e) => void)

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Returns void

dispatchEvent

Parameters

e: TEvents

Returns boolean

init

Returns void

removeEventListener

Type Parameters

T extends string

E extends TypedEvent<AbstractPlugin<never>> & { type: T; }

Parameters

type: TEvents["type"]

callback: EventListenerObject | ((e) => void)

Optional options: boolean | EventListenerOptions

Returns void

setOption

Type Parameters

T extends string | number | symbol

Parameters

option: T

value: TUpdatableConfig[T]

Returns void

setOptions

Parameters

options: Partial<TUpdatableConfig>

Returns void

Settings

Member Visibility

Theme

On This Page

Class AbstractConfigurablePlugin<TConfig, TParsedConfig, TUpdatableConfig, TEvents>`Abstract`

`Readonly` config

`Protected` viewer

`Static` `Readonly` VERSION

`Static` configParser

`Static` `Readonly` id

`Static` readonlyOptions

E extends TypedEvent<AbstractPlugin<never>> & {
type: T;
}

`Optional` options: boolean | AddEventListenerOptions

E extends TypedEvent<AbstractPlugin<never>> & {
type: T;
}

`Optional` options: boolean | EventListenerOptions