editor › Globals › VisualizationManager

Class: VisualizationManager

Maintains the visual representation of the CompositeModel and handles rendering and interaction

Hierarchy

• VisualizationManager

Index

Constructors

• constructor

Properties

• changeEventEmitter
• domCanvas
• domContainer
• editor
• renderContext
• visualizedModel

Methods

• _initializeDomElements
• getChangeEventEmitter
• getDomCanvas
• getRenderContext
• initialize
• setCompositeModel
• setCursorIcon

Constructors

constructor

+ new VisualizationManager(defaultContextDomElement: HTMLDivElement, editor: Editor): VisualizationManager

Defined in src/VisualizationManager.ts:24

Parameters:

Name	Type	Description
defaultContextDomElement	HTMLDivElement	- HTML DOM element of the default render context (which contains the required canvasses)
editor	Editor	-

Returns: VisualizationManager

Properties

Private Readonly changeEventEmitter

• changeEventEmitter: EventEmitter‹CompositeModel‹›› = new EventEmitter()

Defined in src/VisualizationManager.ts:24

---

Private domCanvas

• domCanvas: HTMLCanvasElement | null = null

Defined in src/VisualizationManager.ts:16

---

Private domContainer

• domContainer: HTMLDivElement | null = null

Defined in src/VisualizationManager.ts:15

---

Private Readonly editor

• editor: Editor

Defined in src/VisualizationManager.ts:18

---

Private renderContext

• renderContext: RenderContext

Defined in src/VisualizationManager.ts:13

---

Private visualizedModel

• visualizedModel: VisualizedModel | null = null

Defined in src/VisualizationManager.ts:23

Reference to the visualized model used by the renderContext

Methods

_initializeDomElements

▸ _initializeDomElements(defaultContainer: HTMLDivElement): void

Defined in src/VisualizationManager.ts:43

Parameters:

Name	Type
defaultContainer	HTMLDivElement

Returns: void

---

getChangeEventEmitter

▸ getChangeEventEmitter(): IPublicEventEmitterInterface‹CompositeModel›

Defined in src/VisualizationManager.ts:86

Returns: IPublicEventEmitterInterface‹CompositeModel›

---

getDomCanvas

▸ getDomCanvas(): HTMLCanvasElement

Defined in src/VisualizationManager.ts:90

Returns: HTMLCanvasElement

---

getRenderContext

▸ getRenderContext(): RenderContext

Defined in src/VisualizationManager.ts:39

Returns: RenderContext

---

initialize

▸ initialize(renderContextOptions?: any): Promise‹void›

Defined in src/VisualizationManager.ts:64

Create and initialize a RenderContext, bind to its events

Parameters:

Name	Type
renderContextOptions?	any

Returns: Promise‹void›

A promise that resolves, when rendering is ready.

---

setCompositeModel

▸ setCompositeModel(compositeModel: CompositeModel, initBackground: boolean): void

Defined in src/VisualizationManager.ts:75

Sets the CompositeModel to be rendered

Parameters:

Name	Type	Default	Description
compositeModel	CompositeModel	-	the composite model to be set
initBackground	boolean	false	-

Returns: void

---

setCursorIcon

▸ setCursorIcon(cursorIcon: string | null, x: number, y: number): void

Defined in src/VisualizationManager.ts:94

Parameters:

Name	Type	Default
cursorIcon	string | null	-
x	number	0
y	number	0

Returns: void