Class: ExtensionsManager
Class: ExtensionsManager
Extensions store for single RenderManager instance.
Hierarchy
EventTarget↳
ExtensionsManager
Properties
currentCommandExtName
• currentCommandExtName: string
Current command extension extension 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
| Name | Type | Description |
|---|---|---|
eventType | ExtensionEvents | event type. |
eventListener | EventListenerOrEventListenerObject | event listener. |
Returns
void
addExtension
▸ addExtension(extensionType, args?): ExtensionBase
Add additional extension to extensions list.
Parameters
| Name | Type | Description |
|---|---|---|
extensionType | Object | Extension type. Should be nested from ExtensionBase. |
args? | any | Optional arguments. Will be passed into extension constructor as second parameter. |
Returns
Created extension instance.
clear
▸ clear(): void
Clear extensions list.
Returns
void
currentCommandExtension
▸ currentCommandExtension(): ExtensionBase
Get current command extension in ExtansionManager.
Returns
finishCurrentCommandExtension
▸ finishCurrentCommandExtension(): void
Finish current command extension.
Returns
void
getControllerExtensions
▸ getControllerExtensions(): ControllerExtensionBase[]
Get all controller extensions in ExtansionManager.
Returns
getExtensionByName
▸ getExtensionByName(name): ExtensionBase
Get extension by name.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Extension name. |
Returns
Extension if found or undefined if extension not found.
getExtensions
▸ getExtensions(): ExtensionBase[]
Get all extensions list.
Returns
getExtensionsWithHelpDialogs
▸ getExtensionsWithHelpDialogs(): ExtensionBase[]
Get extensions with help dialogs.
Returns
getExtensionsWithToolbars
▸ getExtensionsWithToolbars(): ExtensionBase[]
Get extensions with toolbars list.
Returns
getModeExtensions
▸ getModeExtensions(): ModeExtensionBase[]
Get all mode extensions in ExtansionManager.
Returns
selectControllerExtension
▸ selectControllerExtension(name): void
Select active controller extension.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Name of extension for activation. |
Returns
void
selectModeExtension
▸ selectModeExtension(name): void
Select active mode extension.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Name of extension for activation. |
Returns
void
selectedControllerExtension
▸ selectedControllerExtension(): ControllerExtensionBase
Get current selected controller extension.
Returns
selectedModeExtension
▸ selectedModeExtension(): ModeExtensionBase
Get current selected mode extension.
Returns
setCurrentCommandExtension
▸ setCurrentCommandExtension(name): void
Set current command extension.
Parameters
| Name | Type |
|---|---|
name | string |
Returns
void