Class CanvasRenderer

Hierarchy (View Summary)

BaseRenderer<CanvasRenderingContext2D, Omit<TRendererConfiguration, "guides">>
- CanvasRenderer

Index

Constructors

Methods

clear createCanvas destroy drawModel drawPendingStroke drawSymbol getBounds getRenderingContext init resize resizeContent

Properties

configuration context parent shapeRenderer strokeRenderer textRenderer

Constructors

constructor

new CanvasRenderer(
config: Omit<TRendererConfiguration, "guides">,
): CanvasRenderer
Parameters
- config: Omit<TRendererConfiguration, "guides">
Returns CanvasRenderer
Overrides BaseRenderer.constructor
- Defined in renderer/canvas/CanvasRenderer.ts:28

Methods

clear

clear(): void
Clear/reset the rendering context

Returns void
Overrides BaseRenderer.clear
- Defined in renderer/canvas/CanvasRenderer.ts:138

`Protected`createCanvas

createCanvas(type: string): HTMLCanvasElement
Parameters
- type: string
Returns HTMLCanvasElement
- Defined in renderer/canvas/CanvasRenderer.ts:38

destroy

destroy(): void
Returns void
- Defined in renderer/canvas/CanvasRenderer.ts:130

drawModel

drawModel(model: Model): void
Parameters
- model: Model
Returns void
- Defined in renderer/canvas/CanvasRenderer.ts:106

drawPendingStroke

drawPendingStroke(stroke: Stroke | undefined): void
Parameters
- stroke: Stroke | undefined
Returns void
- Defined in renderer/canvas/CanvasRenderer.ts:114

`Protected`drawSymbol

drawSymbol(context2D: CanvasRenderingContext2D, symbol: TSymbol): void
Parameters
- context2D: CanvasRenderingContext2D
- symbol: TSymbol
Returns void
- Defined in renderer/canvas/CanvasRenderer.ts:65

getBounds

getBounds(): { height: number; width: number; x: number; y: number }
Get the bounds of the rendering area

Returns { height: number; width: number; x: number; y: number }
Inherited from BaseRenderer.getBounds
- Defined in renderer/base/BaseRenderer.ts:49

getRenderingContext

getRenderingContext(): CanvasRenderingContext2D
Get the rendering context (Canvas2D, SVGElement, etc.)

Returns CanvasRenderingContext2D
Overrides BaseRenderer.getRenderingContext
- Defined in renderer/canvas/CanvasRenderer.ts:145

init

init(element: HTMLElement, guide?: { x?: number; y?: number }): void
Initialize the renderer in the given parent element
Parameters
- element: HTMLElement
- Optionalguide: { x?: number; y?: number }
Returns void
Overrides BaseRenderer.init
- Defined in renderer/canvas/CanvasRenderer.ts:81

resize

resize(model: Model): void
Parameters
- model: Model
Returns void
- Defined in renderer/canvas/CanvasRenderer.ts:123

`Protected`resizeContent

resizeContent(): void
Returns void
- Defined in renderer/canvas/CanvasRenderer.ts:48

Properties

configuration

configuration: ConfigType

context

context: {
    capturingCanvas: HTMLCanvasElement;
    capturingCanvasContext: CanvasRenderingContext2D;
    parent: HTMLElement;
    renderingCanvas: HTMLCanvasElement;
    renderingCanvasContext: CanvasRenderingContext2D;
}

parent

parent: HTMLElement

Class CanvasRenderer

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns CanvasRenderer

Methods

clear

Returns void

ProtectedcreateCanvas

Parameters

Returns HTMLCanvasElement

destroy

Returns void

drawModel

Parameters

Returns void

drawPendingStroke

Parameters

Returns void

ProtecteddrawSymbol

Parameters

Returns void

getBounds

Returns { height: number; width: number; x: number; y: number }

getRenderingContext

Returns CanvasRenderingContext2D

init

Parameters

Returns void

resize

Parameters

Returns void

ProtectedresizeContent

Returns void

Properties

configuration

context

parent

shapeRenderer

strokeRenderer

textRenderer

Settings

On This Page

`Protected`createCanvas

`Protected`drawSymbol

`Protected`resizeContent