Interface IViewerPlugin<TViewer, IsSync>

Interface for Viewer Plugins

interface IViewerPlugin<TViewer, IsSync> {
    constructor: {
        PluginType: string;
    };
    dependencies?: Class<IViewerPlugin<TViewer, IsSync>>[];
    dirty?: boolean;
    loadState?: ((prefix?, storage?) => Promise<void>);
    serializeWithViewer?: boolean;
    storeState?: ((prefix?, storage?, data?) => void);
    onAdded(viewer): IsSync extends false
        ? Promise<void>
        : void;
    onRemove(viewer): IsSync extends false
        ? Promise<void>
        : void;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

constructor dependencies? dirty? loadState? serializeWithViewer? storeState?

Methods

onAdded onRemove

Properties

constructor

constructor: {
    PluginType: string;
}

Type declaration

  • PluginType: string

Optional dependencies

dependencies?: Class<IViewerPlugin<TViewer, IsSync>>[]

Optional dirty

dirty?: boolean

Optional loadState

loadState?: ((prefix?, storage?) => Promise<void>)

Type declaration

    • (prefix?, storage?): Promise<void>

    • Parameters

      • Optional prefix: string
      • Optional storage: Storage

      Returns Promise<void>

Optional serializeWithViewer

serializeWithViewer?: boolean

Optional storeState

storeState?: ((prefix?, storage?, data?) => void)

Type declaration

    • (prefix?, storage?, data?): void

    • Parameters

      • Optional prefix: string
      • Optional storage: Storage
      • Optional data: any

      Returns void

Methods

onAdded

onRemove

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc