BlockSuite API Documentation / @blocksuite/affine-block-surface / CanvasRenderer
Class: CanvasRenderer
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:39
Constructors
new CanvasRenderer()
new CanvasRenderer(
options):CanvasRenderer
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:74
Parameters
options
RendererOptions
Returns
CanvasRenderer
Properties
canvas
canvas:
HTMLCanvasElement
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:50
ctx
ctx:
CanvasRenderingContext2D
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:52
elementRenderers
elementRenderers:
Record<string,ElementRenderer>
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:54
grid
grid:
GridManager
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:56
layerManager
layerManager:
LayerManager
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:58
provider
provider:
Partial<EnvProvider>
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:60
stackingCanvasUpdated
stackingCanvasUpdated:
Subject<{added:HTMLCanvasElement[];canvases:HTMLCanvasElement[];removed:HTMLCanvasElement[]; }>
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:62
viewport
viewport:
Viewport
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:68
Accessors
stackingCanvas
Get Signature
get stackingCanvas():
HTMLCanvasElement[]
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:70
Returns
HTMLCanvasElement[]
Methods
addOverlay()
addOverlay(
overlay):void
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:348
Parameters
overlay
Returns
void
attach()
attach(
container):void
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:358
Used to attach main canvas, main canvas will always exist
Parameters
container
HTMLElement
Returns
void
dispose()
dispose():
void
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:366
Returns
void
generateColorProperty()
generateColorProperty(
color,fallback?):string
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:372
Parameters
color
string | { normal: string; } | { dark: string; light: string; }
fallback?
string | { normal: string; } | { dark: string; light: string; }
Returns
string
getCanvasByBound()
getCanvasByBound(
bound,surfaceElements?,canvas?,clearBeforeDrawing?,withZoom?):HTMLCanvasElement
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:378
Parameters
bound
IBound = ...
surfaceElements?
SurfaceElementModel<BaseElementProps>[]
canvas?
HTMLCanvasElement
clearBeforeDrawing?
boolean
withZoom?
boolean
Returns
HTMLCanvasElement
getColorScheme()
getColorScheme():
ColorScheme
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:408
Returns
getColorValue()
getColorValue(
color,fallback?,real?):string
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:412
Parameters
color
string | { normal: string; } | { dark: string; light: string; }
fallback?
string | { normal: string; } | { dark: string; light: string; }
real?
boolean
Returns
string
getPropertyValue()
getPropertyValue(
property):string
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:418
Parameters
property
string
Returns
string
refresh()
refresh():
void
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:422
Returns
void
removeOverlay()
removeOverlay(
overlay):void
Defined in: packages/affine/blocks/block-surface/src/renderer/canvas-renderer.ts:431
Parameters
overlay
Returns
void