Renderer

Defined in: render/Renderer.ts:18

Abstract renderer interface for diagram parts.

Methods

clear()

clear(): void

Defined in: render/Renderer.ts:20

Clear the entire canvas.

Returns

void

---

clearNodeBounds()

clearNodeBounds(): void

Defined in: render/Renderer.ts:71

Clear all registered node bounds.

Returns

void

---

diagramToScreen()

diagramToScreen(diagramX, diagramY): object

Defined in: render/Renderer.ts:62

Convert diagram coordinates to screen coordinates.

Parameters

diagramX

number

diagramY

number

Returns

object

x

x: number

y

y: number

---

getCanvas()

getCanvas(): HTMLCanvasElement

Defined in: render/Renderer.ts:65

Get the underlying canvas element.

Returns

HTMLCanvasElement

---

getOffset()

getOffset(): object

Defined in: render/Renderer.ts:56

Get the current offset.

Returns

object

x

x: number

y

y: number

---

getScale()

getScale(): number

Defined in: render/Renderer.ts:53

Get the current scale.

Returns

number

---

renderGrid()

renderGrid(viewport, gridSize, pattern?): void

Defined in: render/Renderer.ts:41

Render a grid background, optionally styled by a diagram.grid pattern.

Parameters

viewport

Rect

gridSize

number

pattern?

GridPatternStyle

Returns

void

---

renderGroup()

renderGroup(group): void

Defined in: render/Renderer.ts:32

Render a group (background bounds).

Parameters

group

Group

Returns

void

---

renderLink()

renderLink(link): void

Defined in: render/Renderer.ts:29

Render a link.

Parameters

link

Link

Returns

void

---

renderNode()

renderNode(node): void

Defined in: render/Renderer.ts:26

Render a node.

Parameters

node

Node

Returns

void

---

renderPart()

renderPart(part): void

Defined in: render/Renderer.ts:35

Render a bare decorative Part (not a Node/Link/Group) via its panel.

Parameters

part

Part

Returns

void

---

renderSelectionRect()

renderSelectionRect(rect): void

Defined in: render/Renderer.ts:38

Render a selection rectangle.

Parameters

rect

Rect

Returns

void

---

resize()

resize(): void

Defined in: render/Renderer.ts:23

Resize the canvas to fit its container.

Returns

void

---

restore()

restore(): void

Defined in: render/Renderer.ts:47

Restore the previously saved canvas state.

Returns

void

---

save()

save(): void

Defined in: render/Renderer.ts:44

Save the current canvas state.

Returns

void

---

screenToDiagram()

screenToDiagram(screenX, screenY): object

Defined in: render/Renderer.ts:59

Convert screen coordinates to diagram coordinates.

Parameters

screenX

number

screenY

number

Returns

object

x

x: number

y

y: number

---

setNodeBounds()

setNodeBounds(key, bounds): void

Defined in: render/Renderer.ts:68

Register a node’s bounds for link routing computation.

Parameters

key

string | number

bounds

Rect

Returns

void

---

setViewport()

setViewport(x, y, scale): void

Defined in: render/Renderer.ts:50

Set the viewport (pan/zoom).

Parameters

x

number

y

number

scale

number

Returns

void