Class: RendererUiPlugin

UI-Plugins.RendererUiPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ RendererUiPlugin

Properties

PluginType

▪ Static Readonly PluginType: "RendererParamsUiPlugin"

Defined in

webgi/src/ui/RendererUiPlugin.ts:10

---

MaxCanvasScale

▪ Static Readonly MaxCanvasScale: 5

Defined in

webgi/src/ui/RendererUiPlugin.ts:14

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/ui/RendererUiPlugin.ts:11

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/ui/RendererUiPlugin.ts:12

---

mode

• mode: "full" | "custom" = 'full'

Defined in

webgi/src/ui/RendererUiPlugin.ts:26

---

width

• width: number = 0

Defined in

webgi/src/ui/RendererUiPlugin.ts:36

---

height

• height: number = 0

Defined in

webgi/src/ui/RendererUiPlugin.ts:46

---

scale

• scale: number = 1

Defined in

webgi/src/ui/RendererUiPlugin.ts:54

---

_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

---

_serializeVersion

• Protected _serializeVersion: number = 1

Defined in

webgi/src/ui/RendererUiPlugin.ts:17

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

refreshSize

▸ refreshSize(): void

Returns

void

Defined in

webgi/src/ui/RendererUiPlugin.ts:62

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/ui/RendererUiPlugin.ts:137

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/ui/RendererUiPlugin.ts:151

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | RendererUiPlugin | Promise<null | RendererUiPlugin>

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/ui/RendererUiPlugin.ts:165

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/ui/RendererUiPlugin.ts:185

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

• new RendererUiPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/ui/RendererUiPlugin.ts:56