Skip to main content

Class: PresetLibraryPlugin

Plugins.PresetLibraryPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "PresetLibraryPlugin"


toJSON

toJSON: any = null

Overrides

AViewerPlugin.toJSON


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled


presetGroups

presetGroups: PresetGroup[] = []


uiConfig

uiConfig: UiObjectConfig<any, string>


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Constructors

constructor

new PresetLibraryPlugin()

Inherited from

AViewerPlugin.constructor

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty


viewer

get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded


exportPresets

exportPresets(): any

Returns

any


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

Promise<null | PresetLibraryPlugin>

Overrides

AViewerPlugin.fromJSON


loadPresetGroups

loadPresetGroups(groups): Promise<void>

Parameters

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

Returns

Promise<void>


exportPresetGroups

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

Returns

Record<string, IAsset[]>


clear

clear(): void

Returns

void


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey