Interface IViewerPluginAsync<TViewer>

Interface for Viewer Plugins

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

Type Parameters

Hierarchy (view full)

Implemented by

Properties

constructor: {
    PluginType: string;
}

Type declaration

  • PluginType: string
dependencies?: Class<IViewerPlugin<ThreeViewer, boolean>>[]
dirty?: boolean
loadState?: ((prefix?, storage?) => Promise<void>)

Type declaration

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

      • Optional prefix: string
      • Optional storage: Storage

      Returns Promise<void>

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

Type declaration

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

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

      Returns void

Methods

Generated using TypeDoc