Class: PresetLibraryPlugin
Plugins.PresetLibraryPlugin
Hierarchy
AViewerPlugin
<""
>↳
PresetLibraryPlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "PresetLibraryPlugin"
toJSON
• toJSON: any
= null
Overrides
enabled
• enabled: boolean
= true
Overrides
presetGroups
• presetGroups: PresetGroup
[] = []
uiConfig
• uiConfig: UiObjectConfig
<any
, string
>
_dirty
• Protected
_dirty: boolean
= false
Inherited from
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Constructors
constructor
• new PresetLibraryPlugin()
Inherited from
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
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
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
exportState
▸ exportState(): any
Returns
any
Inherited from
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
exportPresets
▸ exportPresets(): any
Returns
any
fromJSON
▸ fromJSON(data
, meta?
): Promise
<null
| PresetLibraryPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
Promise
<null
| PresetLibraryPlugin
>
Overrides
loadPresetGroups
▸ loadPresetGroups(groups
): Promise
<void
>
Parameters
Name | Type |
---|---|
groups | string | 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
Name | Type |
---|---|
prefix? | string |
Returns
string