Skip to main content

Class: AViewerPlugin<T, TViewer>

Core-API.AViewerPlugin

Type parameters

NameType
Textends string
TViewerextends IViewerApp = ViewerApp

Hierarchy

Implements

Constructors

constructor

new AViewerPlugin<T, TViewer>()

Type parameters

NameType
Textends string
TViewerextends IViewerApp<TViewer> = ViewerApp

Inherited from

SimpleEventDispatcher<T|'serialize'|'deserialize'>.constructor

Defined in

webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Properties

enabled

Abstract enabled: boolean

Defined in

webgi/src/core/AViewerPlugin.ts:30


_dirty

Protected _dirty: boolean = false

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: TViewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Methods

onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Defined in

webgi/src/core/AViewerPlugin.ts:32


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45


fromJSON

fromJSON(data, meta?): null | AViewerPlugin<T, TViewer> | Promise<null | AViewerPlugin<T, TViewer>>

Parameters

NameType
dataany
meta?any

Returns

null | AViewerPlugin<T, TViewer> | Promise<null | AViewerPlugin<T, TViewer>>

Implementation of

IViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Defined in

webgi/src/core/AViewerPlugin.ts:60