Skip to main content

Interface: IViewerPluginAsync<TViewer>

Core-API.IViewerPluginAsync

Type parameters

NameType
TViewerextends IViewerApp = IViewerApp

Hierarchy

Properties

dirty

Optional dirty: boolean

Inherited from

IViewerPlugin.dirty

Defined in

webgi/src/interfaces.ts:511


serializeWithViewer

Optional serializeWithViewer: boolean

Inherited from

IViewerPlugin.serializeWithViewer

Defined in

webgi/src/interfaces.ts:522


dependencies

Optional dependencies: Class<IViewerPlugin<IViewerApp, boolean>>[]

Overrides

IViewerPlugin.dependencies

Defined in

webgi/src/interfaces.ts:540


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IViewerPlugin.uiConfig

Defined in

webgi/src/interfaces.ts:586

Methods

storeState

Optional storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

IViewerPlugin.storeState

Defined in

webgi/src/interfaces.ts:524


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

IViewerPlugin.loadState

Defined in

webgi/src/interfaces.ts:525


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Overrides

IViewerPlugin.onAdded

Defined in

webgi/src/interfaces.ts:537


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Overrides

IViewerPlugin.onRemove

Defined in

webgi/src/interfaces.ts:538


onDispose

Optional onDispose(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Overrides

IViewerPlugin.onDispose

Defined in

webgi/src/interfaces.ts:539