BlockSuite API Documentation / @blocksuite/blocks / Overlay

Class: abstract Overlay

An overlay is a layer covered on top of elements, can be used for rendering non-CRDT state indicators.

Extended by

• ConnectionOverlay

Constructors

new Overlay()

new Overlay(): Overlay

Returns

Overlay

Defined in

packages/affine/block-surface/dist/renderer/canvas-renderer.d.ts:14

Properties

_renderer

protected _renderer: null | CanvasRenderer

Defined in

packages/affine/block-surface/dist/renderer/canvas-renderer.d.ts:13

Methods

clear()

clear(): void

Returns

void

Defined in

packages/affine/block-surface/dist/renderer/canvas-renderer.d.ts:15

---

render()

abstract render(ctx, rc): void

Parameters

• ctx: CanvasRenderingContext2D

• rc: RoughCanvas

Returns

void

Defined in

packages/affine/block-surface/dist/renderer/canvas-renderer.d.ts:16

---

setRenderer()

setRenderer(renderer): void

Parameters

• renderer: null | CanvasRenderer

Returns

void

Defined in

packages/affine/block-surface/dist/renderer/canvas-renderer.d.ts:17