Class: RendererUiPlugin

UI-Plugins.RendererUiPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ RendererUiPlugin

Properties

PluginType

▪ Static Readonly PluginType: "RendererParamsUiPlugin"

---

MaxCanvasScale

▪ Static Readonly MaxCanvasScale: 5

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

---

mode

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

---

width

• width: number = 0

---

height

• height: number = 0

---

scale

• scale: number = 1

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

---

_serializeVersion

• Protected _serializeVersion: number = 1

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

AViewerPlugin.onDispose

---

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

---

refreshSize

▸ refreshSize(): void

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

---

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

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Overrides

AViewerPlugin.toJSON

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new RendererUiPlugin()

Overrides

AViewerPlugin.constructor