Canvas2DRenderer

Defined in: render/Canvas2DRenderer.ts:24

Canvas 2D renderer for diagram parts.

Implements

• Renderer

Constructors

Constructor

new Canvas2DRenderer(canvas): Canvas2DRenderer

Defined in: render/Canvas2DRenderer.ts:75

Parameters

canvas

HTMLCanvasElement

Returns

Canvas2DRenderer

Accessors

dirtyRectCount

Get Signature

get dirtyRectCount(): number

Defined in: render/Canvas2DRenderer.ts:167

Get the number of pending dirty rectangles.

Returns

number

Methods

clear()

clear(): void

Defined in: render/Canvas2DRenderer.ts:119

Clear the entire canvas.

Returns

void

Implementation of

Renderer.clear

---

clearDirtyRects()

clearDirtyRects(): void

Defined in: render/Canvas2DRenderer.ts:172

Clear all pending dirty rectangles without clearing the canvas.

Returns

void

---

clearNodeBounds()

clearNodeBounds(): void

Defined in: render/Canvas2DRenderer.ts:66

Clear all registered node bounds.

Returns

void

Implementation of

Renderer.clearNodeBounds

---

diagramToScreen()

diagramToScreen(diagramX, diagramY): object

Defined in: render/Canvas2DRenderer.ts:750

Convert diagram coordinates to screen coordinates.

Parameters

diagramX

number

diagramY

number

Returns

object

x

x: number

y

y: number

Implementation of

Renderer.diagramToScreen

---

disableDirtyRects()

disableDirtyRects(): void

Defined in: render/Canvas2DRenderer.ts:138

Disable dirty-rectangle rendering (full clear each frame).

Returns

void

---

enableDirtyRects()

enableDirtyRects(): void

Defined in: render/Canvas2DRenderer.ts:133

Enable dirty-rectangle rendering.

Returns

void

---

getCanvas()

getCanvas(): HTMLCanvasElement

Defined in: render/Canvas2DRenderer.ts:100

Get the canvas element.

Returns

HTMLCanvasElement

Implementation of

Renderer.getCanvas

---

getContext()

getContext(): CanvasRenderingContext2D

Defined in: render/Canvas2DRenderer.ts:105

Get the rendering context.

Returns

CanvasRenderingContext2D

---

getLabelsVisible()

getLabelsVisible(): boolean

Defined in: render/Canvas2DRenderer.ts:51

Check whether labels are currently visible.

Returns

boolean

---

getOffset()

getOffset(): object

Defined in: render/Canvas2DRenderer.ts:739

Get the current offset.

Returns

object

x

x: number

y

y: number

Implementation of

Renderer.getOffset

---

getPathCache()

getPathCache(): PathCache

Defined in: render/Canvas2DRenderer.ts:110

Get the path cache.

Returns

PathCache

---

getScale()

getScale(): number

Defined in: render/Canvas2DRenderer.ts:735

Get the current scale.

Returns

number

Implementation of

Renderer.getScale

---

getTextMeasureCache()

getTextMeasureCache(): TextMeasureCache

Defined in: render/Canvas2DRenderer.ts:115

Get the text measure cache.

Returns

TextMeasureCache

---

invalidateLinkPaths()

invalidateLinkPaths(): void

Defined in: render/Canvas2DRenderer.ts:38

Invalidate all cached link paths (e.g. when nodes move).

Returns

void

---

isDirtyRectEnabled()

isDirtyRectEnabled(): boolean

Defined in: render/Canvas2DRenderer.ts:144

Check whether dirty-rectangle rendering is enabled.

Returns

boolean

---

markDirty()

markDirty(x, y, width, height): void

Defined in: render/Canvas2DRenderer.ts:149

Add a dirty rectangle in diagram coordinates (converted to screen space).

Parameters

x

number

y

number

width

number

height

number

Returns

void

---

markDirtyRect()

markDirtyRect(bounds): void

Defined in: render/Canvas2DRenderer.ts:162

Mark an entire part’s bounds as dirty.

Parameters

bounds

Rect

Returns

void

---

renderGrid()

renderGrid(viewport, gridSize, pattern?): void

Defined in: render/Canvas2DRenderer.ts:683

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

Parameters

viewport

Rect

gridSize

number

pattern?

GridPatternStyle

Returns

void

Implementation of

Renderer.renderGrid

---

renderGroup()

renderGroup(group): void

Defined in: render/Canvas2DRenderer.ts:604

Render a group (background bounds).

Parameters

group

Group

Returns

void

Implementation of

Renderer.renderGroup

---

renderLink()

renderLink(link): void

Defined in: render/Canvas2DRenderer.ts:326

Render a link.

Parameters

link

Link

Returns

void

Implementation of

Renderer.renderLink

---

renderNode()

renderNode(node): void

Defined in: render/Canvas2DRenderer.ts:176

Render a node.

Parameters

node

Node

Returns

void

Implementation of

Renderer.renderNode

---

renderPanel()

renderPanel(panel, x, y, width, height): void

Defined in: render/Canvas2DRenderer.ts:292

Render a panel at the given position and size.

Parameters

panel

Panel

x

number

y

number

width

number

height

number

Returns

void

---

renderPart()

renderPart(part): void

Defined in: render/Canvas2DRenderer.ts:646

GoJS-compatible: render a bare decorative Part (not a Node/Link/ Group) — e.g. a frame or watermark added via Diagram.add() outside the model. Only draws if it has a panel (from a template); a decorative Part with no panel has nothing to render.

Parameters

part

Part

Returns

void

Implementation of

Renderer.renderPart

---

renderSelectionHandles()

renderSelectionHandles(x, y, width, height): void

Defined in: render/Canvas2DRenderer.ts:246

Render resize handles and rotation handle for a selected node.

Parameters

x

number

y

number

width

number

height

number

Returns

void

---

renderSelectionRect()

renderSelectionRect(rect): void

Defined in: render/Canvas2DRenderer.ts:671

Render a selection rectangle.

Parameters

rect

Rect

Returns

void

Implementation of

Renderer.renderSelectionRect

---

resize()

resize(): void

Defined in: render/Canvas2DRenderer.ts:95

Resize the canvas to fit its container.

Returns

void

Implementation of

Renderer.resize

---

restore()

restore(): void

Defined in: render/Canvas2DRenderer.ts:721

Restore the previously saved canvas state.

Returns

void

Implementation of

Renderer.restore

---

save()

save(): void

Defined in: render/Canvas2DRenderer.ts:717

Save the current canvas state.

Returns

void

Implementation of

Renderer.save

---

screenToDiagram()

screenToDiagram(screenX, screenY): object

Defined in: render/Canvas2DRenderer.ts:743

Convert screen coordinates to diagram coordinates.

Parameters

screenX

number

screenY

number

Returns

object

x

x: number

y

y: number

Implementation of

Renderer.screenToDiagram

---

setLabelsVisible()

setLabelsVisible(value): void

Defined in: render/Canvas2DRenderer.ts:46

Set whether node labels should be rendered (used for LOD).

Parameters

value

boolean

Returns

void

---

setNodeBounds()

setNodeBounds(key, bounds): void

Defined in: render/Canvas2DRenderer.ts:61

Register a node’s bounds for link routing computation.

Parameters

key

string | number

bounds

Rect

Returns

void

Implementation of

Renderer.setNodeBounds

---

setSelectionStyle()

setSelectionStyle(style): void

Defined in: render/Canvas2DRenderer.ts:56

Set the colors used for selection highlights and resize handles.

Parameters

style

SelectionStyle

Returns

void

---

setViewport()

setViewport(x, y, scale): void

Defined in: render/Canvas2DRenderer.ts:725

Set the viewport (pan/zoom).

Parameters

x

number

y

number

scale

number

Returns

void

Implementation of

Renderer.setViewport