tangl-viewer

---

Class: ExtensionsManager

Extensions store for single RenderManager instance.

Extends

• EventTarget

Properties

compactMode

compactMode: boolean

Compact mode for extensions UI.

---

currentCommandExtName

currentCommandExtName: string

Current command extension name.

---

currentCommandName

currentCommandName: string

Current command name.

---

selectedControllerExtName

selectedControllerExtName: string

Current selected controller extension name.

---

selectedModeExtName

selectedModeExtName: string

Current selected mode extension name.

---

viewerName

viewerName: string

The name of the viewer under which the associated RenderManager is stored in the ViewerStore.

Methods

addAutoEventListener()

addAutoEventListener(eventType, eventListener): void

Add event listener with automatic dispose.

Parameters

eventType

ExtensionEvents

event type.

eventListener

EventListenerOrEventListenerObject

event listener.

Returns

void

---

addExtension()

addExtension(extensionType, args?): Promise<ExtensionBase>

Add additional extension to extensions list.

Parameters

extensionType

Object

Extension type. Should be nested from ExtensionBase.

args?

any

Optional arguments. Will be passed into extension constructor as second parameter.

Returns

Promise<ExtensionBase>

Created extension instance.

---

clear()

clear(): void

Clear extensions list.

Returns

void

---

currentCommandExtension()

currentCommandExtension(): ExtensionBase

Get current command extension in ExtansionManager.

Returns

ExtensionBase

---

finishCurrentCommandExtension()

finishCurrentCommandExtension(): void

Finish current command extension.

Returns

void

---

getControllerExtensions()

getControllerExtensions(): ControllerExtensionBase[]

Get all controller extensions in ExtansionManager.

Returns

ControllerExtensionBase[]

---

getExtensionByName()

getExtensionByName(name): ExtensionBase

Get extension by name.

Parameters

name

string

Extension name.

Returns

ExtensionBase

Extension if found or undefined if extension not found.

---

getExtensions()

getExtensions(): ExtensionBase[]

Get all extensions list.

Returns

ExtensionBase[]

---

getExtensionsHelpers()

getExtensionsHelpers(): HelperAction[]

Get extension helpers list.

Returns

HelperAction[]

---

getExtensionsWithToolbars()

getExtensionsWithToolbars(): ExtensionBase[]

Get extensions with toolbars list.

Returns

ExtensionBase[]

---

getModeExtensions()

getModeExtensions(): ModeExtensionBase<any>[]

Get all mode extensions in ExtansionManager.

Returns

ModeExtensionBase<any>[]

---

requestHelpersUpdate()

requestHelpersUpdate(): void

Request helpers toolbar update when helpers list from extensions changed.

Returns

void

---

selectControllerExtension()

selectControllerExtension(name): void

Select active controller extension.

Parameters

name

string

Name of extension for activation.

Returns

void

---

selectedControllerExtension()

selectedControllerExtension(): ControllerExtensionBase

Get current selected controller extension.

Returns

ControllerExtensionBase

---

selectedModeExtension()

selectedModeExtension(): ModeExtensionBase<any>

Get current selected mode extension.

Returns

ModeExtensionBase<any>

---

selectModeExtension()

selectModeExtension(name): void

Select active mode extension.

Parameters

name

string

Name of extension for activation.

Returns

void

---

setCompactMode()

setCompactMode(mode?): void

Set compact mode for extensions UI..

Parameters

mode?

boolean

Compact mode.

Returns

void

---

setCurrentCommandExtension()

setCurrentCommandExtension(extensionName, commandName?): void

Set current command extension and name.

Parameters

extensionName

string

commandName?

string

Returns

void