Documentation

---

Class: GeneralModeExtension

General mode extension. Used for common model view state. Does not have any specific options.

Extends

• ModeExtensionBase<any>

Constructors

Constructor

new GeneralModeExtension(viewerName, options): GeneralModeExtension

Parameters

viewerName

string

Owner viewer name.

options

additional options for extension.

restoreTooltipStateHandler?

Function

saveTooltipStateHandler?

Function

Returns

GeneralModeExtension

Overrides

ModeExtensionBase.constructor

Properties

enableTooltip

enableTooltip: boolean

Enable or disable viewer tooltip feature for this extension.

Inherited from

ModeExtensionBase.enableTooltip

---

getName()

getName: () => string

Get unique extension name.

Returns

string

Inherited from

ModeExtensionBase.getName

---

helpDesc

readonly helpDesc: string

Optional description for placing on HelpToolbar.

Inherited from

ModeExtensionBase.helpDesc

---

helpIcon

readonly helpIcon: string

Optional icon for placing on HelpToolbar.

Inherited from

ModeExtensionBase.helpIcon

---

hideToolbar

hideToolbar: boolean

Is extension need to hide toolbar or not.

Inherited from

ModeExtensionBase.hideToolbar

---

modeDesc

readonly modeDesc: string

Mode description or name.

Inherited from

ModeExtensionBase.modeDesc

---

modeIcon

readonly modeIcon: string

Mode icon name. Icon name will be used by viewer Toolbar UI component for displaying mode buttons.

Inherited from

ModeExtensionBase.modeIcon

---

showTooltip

showTooltip: boolean

Show or hide viewer tooltip feature if enableTooltip == true.

Inherited from

ModeExtensionBase.showTooltip

---

state

state: any

Any extension data which can be stored in browser local storage and restored after (any extension settings, buttons state and so one). State will be saved in local storage with 'tangl-ext-extensionName' key.

Inherited from

ModeExtensionBase.state

---

type

readonly type: string

Extension type (ext, mode, control).

Inherited from

ModeExtensionBase.type

---

viewerName

readonly viewerName: string

Owner viewer name.

Inherited from

ModeExtensionBase.viewerName

---

getName()

static getName: () => string

Get unique extension name.

Returns

string

Overrides

ModeExtensionBase.getName

Methods

clearData()

clearData(): void

Clear resource array, details array and elements list.

Returns

void

Inherited from

ModeExtensionBase.clearData

---

getRenderManager()

getRenderManager(): RenderManager

Get current RenderManager instance.

Returns

RenderManager

Inherited from

ModeExtensionBase.getRenderManager

---

modeIconRender()

modeIconRender(container): void

Render function for rendering icon content for Toolbar component.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ModeExtensionBase.modeIconRender

---

restoreState()

restoreState(): Promise<void>

Restore extension state from the local storage.

Returns

Promise<void>

Inherited from

ModeExtensionBase.restoreState

---

restoreTooltipState()

restoreTooltipState(): void

Restore enableTooltip state from local storage.

Returns

void

Inherited from

ModeExtensionBase.restoreTooltipState

---

saveState()

saveState(): Promise<void>

Save extension state in the local storage.

Returns

Promise<void>

Inherited from

ModeExtensionBase.saveState

---

saveTooltipState()

saveTooltipState(): void

Save enableTooltip state to local storage.

Returns

void

Inherited from

ModeExtensionBase.saveTooltipState

---

setData()

setData(elNums, resourceArray, details, forceClearData?): void

Set data to resource array and details array for elements list.

Parameters

elNums

number[]

Elements self Ids.

resourceArray

any[]

Resource data array.

details

any

Details data array.

forceClearData?

boolean

force clear data after applying by extension.

Returns

void

Inherited from

ModeExtensionBase.setData

---

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

ModeExtensionBase.setRestoreStateHandler

---

setRestoreTooltipStateHandler()

setRestoreTooltipStateHandler(handler): this

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

Parameters

handler

Function

handler hook function.

Returns

this

Inherited from

ModeExtensionBase.setRestoreTooltipStateHandler

---

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

ModeExtensionBase.setSaveStateHandler

---

setSaveTooltipStateHandler()

setSaveTooltipStateHandler(handler): this

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

Parameters

handler

Function

handler hook function.

Returns

this

Inherited from

ModeExtensionBase.setSaveTooltipStateHandler

---

setup()

setup(): void

Setup viewer state and modify elements by this state. Should be overridden by each mode extension.

Returns

void

Overrides

ModeExtensionBase.setup

---

tooltipRender()

tooltipRender(container): void

Render function for rendering tooltip content when enableTooltip == true.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Overrides

ModeExtensionBase.tooltipRender

Hooks

added()

added(): void

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

Returns

void

Overrides

ModeExtensionBase.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

ModeExtensionBase.commandChanged

---

dedicatedToolbarRender()

dedicatedToolbarRender(container): void

Render function for rendering dedicated toolbar content.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ModeExtensionBase.dedicatedToolbarRender

---

deleted()

deleted(): void

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

Returns

void

Overrides

ModeExtensionBase.deleted

---

selected()

selected(): void

Hook when extension is activated (selected as current mode). Called by ExtensionManager.selectControllerExtension().

Returns

void

Overrides

ModeExtensionBase.selected

---

sharedToolbarRender()

sharedToolbarRender(container): void

Render function for rendering shared toolbar content.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ModeExtensionBase.sharedToolbarRender

---

uiRender()

uiRender(container): void

Render function for rendering additional UI above viewer canvas.

Parameters

container

HTMLElement

Parent DOM container.

Returns

void

Inherited from

ModeExtensionBase.uiRender

---

unselected()

unselected(): void

Hook when extension is deactivated. Called by ExtensionManager.selectControllerExtension()

Returns

void

Overrides

ModeExtensionBase.unselected