Class SettingsPlugin

Adds a button to access various settings

Hierarchy (View Summary)

AbstractPlugin<SettingsPluginEvents>
- SettingsPlugin

Index

Constructors

Properties

config settings viewer id VERSION

Methods

addEventListener addSetting dispatchEvent hideSettings removeEventListener removeSetting showSettings toggleSettings updateButton withConfig

Constructors

constructor

new SettingsPlugin(viewer: Viewer, config: SettingsPluginConfig): SettingsPlugin
Parameters
- viewer: Viewer
- config: SettingsPluginConfig
Returns SettingsPlugin
Overrides AbstractPlugin.constructor
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:47

Properties

`Readonly`config

config: SettingsPluginConfig

`Readonly`settings

settings: Setting[] = []

`Protected`viewer

viewer: Viewer

`Static` `Readonly`id

id: "settings" = 'settings'

Unique identifier of the plugin

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

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

addSetting

addSetting(setting: Setting): void
Registers a new setting
Parameters
- setting: Setting
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:98

dispatchEvent

dispatchEvent(e: SettingChangedEvent): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- e: SettingChangedEvent
Returns boolean
Inherited from AbstractPlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

hideSettings

hideSettings(): void
Hides the settings menu

Returns void
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:181

removeEventListener

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

removeSetting

removeSetting(id: string): void
Removes a setting
Parameters
- id: string
Returns void
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:154

showSettings

showSettings(): void
Shows the settings menu

Returns void
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:190

toggleSettings

toggleSettings(): void
Toggles the settings menu

Returns void
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:170

updateButton

updateButton(): void
Updates the badge in the button

Returns void
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:199

`Static`withConfig

withConfig(config: SettingsPluginConfig): [PluginConstructor, any]
Parameters
- config: SettingsPluginConfig
Returns [PluginConstructor, any]
- Defined in packages/settings-plugin/src/SettingsPlugin.ts:43