Interface IViewerPluginAsync<TViewer>

Interface for Viewer Plugins

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

Type Parameters

Hierarchy (View Summary)

Implemented by

Indexable

  • [key: string]: any

Properties

constructor dependencies? dirty? loadState? serializeWithViewer? storeState?

Methods

onAdded onRemove

Properties

constructor

constructor: { OldPluginType?: string; PluginType: string }

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Optionaldependencies

dependencies?: Class<IViewerPlugin>[]

Optionaldirty

dirty?: boolean

OptionalloadState

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

OptionalserializeWithViewer

serializeWithViewer?: boolean

OptionalstoreState

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

Methods

onAdded

onRemove

Settings

Member Visibility

On This Page

Properties
Methods