Skip to main content

Class: PresetLibraryPlugin

Plugins.PresetLibraryPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "PresetLibraryPlugin"

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:19


toJSON

toJSON: any = null

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:21


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:23


presetGroups

presetGroups: PresetGroup[] = []

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:25


uiConfig

uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:102


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Constructors

constructor

new PresetLibraryPlugin()

Inherited from

AViewerPlugin.constructor

Defined in

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

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


viewer

get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

AViewerPlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:44


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:27


exportPresets

exportPresets(): any

Returns

any

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:45


fromJSON

fromJSON(data, meta?): Promise<null | PresetLibraryPlugin>

Parameters

NameType
dataany
meta?any

Returns

Promise<null | PresetLibraryPlugin>

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:54


loadPresetGroups

loadPresetGroups(groups): Promise<void>

Parameters

NameType
groupsstring | Record<string, (string | IAsset)[]>

Returns

Promise<void>

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:80


exportPresetGroups

exportPresetGroups(): Record<string, IAsset[]>

Returns

Record<string, IAsset[]>

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:90


clear

clear(): void

Returns

void

Defined in

webgi/src/plugins/PresetLibraryPlugin.ts:96


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64