Class: ExtrasUiPlugin

UI-Plugins.ExtrasUiPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ ExtrasUiPlugin

Properties

PluginType

▪ Static Readonly PluginType: "ExtrasUiPlugin1"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

---

showColorScheme

• showColorScheme: boolean = true

---

uiConfig

• uiConfig: Object

Type declaration

Name	Type
type	string
label	string
limitedUi	boolean
children	(() => undefined | { label: string = 'Color Scheme'; type: string = 'dropdown'; children: { label: string = v }[] ; getValue: () => undefined | "black" | "white" | "blue" ; setValue: (v: "black" | "white" | "blue") => void } | () => { label: string = 'Shadow type'; type: string = 'dropdown'; children: { label: string | 0 | 1 | 2 | 3 ; value: string | 0 | 1 | 2 | 3 }[] ; getValue: () => undefined | ShadowMapType ; setValue: (v: ShadowMapType) => void } | () => { label: string ; type: string = 'button'; value: () => Promise<void> } | { label: string = 'Auto GPU instance all'; type: string = 'button'; value: () => void })[]

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Constructors

constructor

• new ExtrasUiPlugin()

Inherited from

AViewerPlugin.constructor

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

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onAdded

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | ExtrasUiPlugin | Promise<null | ExtrasUiPlugin>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey