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.

Contents

• Constructors
  • new Overlay(undefined)
• Methods
  • abstract render()

Constructors

new Overlay(undefined)

new Overlay(): Overlay

Returns

Overlay

Methods

abstract render()

abstract render(ctx, rc): void

Parameters

• ctx: CanvasRenderingContext2D

• rc: RoughCanvas

Returns

void

Source

packages/blocks/src/surface-block/renderer.ts:59

---

Generated using typedoc-plugin-markdown and TypeDoc