Documentation - v20.0.0-dev
    Preparing search index...

    Class ViewerPlugin<TSettings>Abstract

    Base class for a ViewerPlugin.

    Type Parameters

    Index

    Constructors

    Properties

    name: string

    Display name of the plugin

    settings: TSettings

    Its settings: those saved in the local storage set, then config.

    viewer: Viewer

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly never[]

    • Whether the plugin has at least one setting an interface shows (not hidden).

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    • A base class for a plugin of this name, its settings an instance of SettingsClass (EmptySettings for none): class MyPlugin extends ViewerPlugin.Create('MyPlugin', MySettings) {}.

      Type Parameters

      Parameters

      • name: string
      • SettingsClass: new () => S

      Returns typeof PluginClass