Documentation

---

Class: SettingsExtension

Viewer settings extension.

Extends

• ExtensionBase

Implements

• ViewpointState

Constructors

Constructor

new SettingsExtension(viewerName, options): SettingsExtension

Parameters

viewerName

string

Owner viewer name.

options

additional options for extension.

restoreStateHandler?

(stateName, state) => Promise<any>

saveStateHandler?

(stateName, state) => void

Returns

SettingsExtension

Overrides

ExtensionBase.constructor

Properties

getName()

getName: () => string

Get unique extension name.

Returns

string

Inherited from

ExtensionBase.getName

---

helpDesc

readonly helpDesc: string

Optional description for placing on HelpToolbar.

Inherited from

ExtensionBase.helpDesc

---

helpIcon

readonly helpIcon: string

Optional icon for placing on HelpToolbar.

Inherited from

ExtensionBase.helpIcon

---

hideToolbar

hideToolbar: boolean

Is extension need to hide toolbar or not.

Inherited from

ExtensionBase.hideToolbar

---

state

state: RenderSettingsState

General extension data which can be stored in browser local storage and restored after. State will be saved in local storage with 'tangl-ext-extensionName' key.

Overrides

ExtensionBase.state

---

type

readonly type: string

Extension type (ext, mode, control).

Inherited from

ExtensionBase.type

---

viewerName

readonly viewerName: string

Owner viewer name.

Inherited from

ExtensionBase.viewerName

---

getName()

static getName: () => string

Get unique extension name.

Returns

string

Overrides

ExtensionBase.getName

Methods

getRenderManager()

getRenderManager(): RenderManager

Get current RenderManager instance.

Returns

RenderManager

Inherited from

ExtensionBase.getRenderManager

---

restoreState()

restoreState(): Promise<void>

Restore extension state from the local storage.

Returns

Promise<void>

Inherited from

ExtensionBase.restoreState

---

saveState()

saveState(): Promise<void>

Save extension state in the local storage.

Returns

Promise<void>

Inherited from

ExtensionBase.saveState

---

setRestoreStateHandler()

setRestoreStateHandler(handler): this

Sets external hook handler for restoring extension state in the local storage.

Parameters

handler

(stateName, state) => Promise<any>

handler hook function.

Returns

this

Inherited from

ExtensionBase.setRestoreStateHandler

---

setSaveStateHandler()

setSaveStateHandler(handler): this

Sets external hook handler for storing extension state in the local storage.

Parameters

handler

(stateName, state) => void

handler hook function.

Returns

this

Inherited from

ExtensionBase.setSaveStateHandler

Hooks

added()

added(): Promise<void>

Hook when extension is added to ExtensionManager. Called by ExtensionManager.addExtension().

Returns

Promise<void>

Overrides

ExtensionBase.added

---

commandChanged()

commandChanged(newCommand): void

Hook when current extension command is changed or finished. Called by ExtensionManager.setCurrentCommandExtension().

Parameters

newCommand

ExtensionBase

Returns

void

Inherited from

ExtensionBase.commandChanged

---

dedicatedToolbarRender()

dedicatedToolbarRender(container): void

Render function for rendering dedicated toolbar content.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ExtensionBase.dedicatedToolbarRender

---

deleted()

deleted(): void

Hook when extension is deleted from ExtensionManager. Called by ExtensionManager.clear().

Returns

void

Overrides

ExtensionBase.deleted

---

sharedToolbarRender()

sharedToolbarRender(container): void

Render function for rendering shared toolbar content.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Overrides

ExtensionBase.sharedToolbarRender

---

uiRender()

uiRender(container): void

Render function for rendering additional UI above viewer canvas.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ExtensionBase.uiRender