Class ViewerPlugin<TSettings>Abstract

constructor

• new ViewerPlugin<TSettings extends SettingsRecord = Record<string, never>>(
      viewer: Viewer,
      name: string,
      settingsFunc: PluginSettingBuildFunction<TSettings>,
      config?: RecursivePartial<ExtractValues<TSettings>>,
  ): ViewerPlugin<TSettings>

  Type Parameters

  • TSettings extends SettingsRecord = Record<string, never>

  Parameters

  • viewer: Viewer
  • name: string
  • settingsFunc: PluginSettingBuildFunction<TSettings>
  • Optionalconfig: RecursivePartial<ExtractValues<TSettings>>

  Returns ViewerPlugin<TSettings>

Readonlyname

Readonlysettings

Readonlyviewer

clear

• clear(): void

  Returns void

dependencies

• dependencies(): readonly never[]

  List of plugins this plugin depends on

  Returns readonly never[]

hasSettings

• hasSettings(): boolean

  Indicates whether the plugin has settings

  Returns boolean

onRegister

• onRegister(): void

  Called when the plugin is registered in the viewer.

  Returns void

onUnregister

• onUnregister(): void

  Called when the plugin is unregistred from the viewer.

  Returns void

StaticCreate

• Create<S extends SettingsRecord = Record<string, never>>(
      name: string,
      settingFunc?: PluginSettingBuildFunction<S>,
  ): typeof PluginClass

  Type Parameters

  • S extends SettingsRecord = Record<string, never>

  Parameters

  • name: string
  • settingFunc: PluginSettingBuildFunction<S> = ...

  Returns typeof PluginClass