BlockSuite API Documentation / @blocksuite/affine-block-surface / Overlay

Class: abstract Overlay

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:16

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

Extends

• Extension

Extended by

• ConnectionOverlay
• FrameOverlay

Constructors

new Overlay()

new Overlay(gfx): Overlay

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:21

Parameters

gfx

GfxController

Returns

Overlay

Overrides

Extension.constructor

Properties

_renderer

protected _renderer: null | CanvasRenderer = null

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:19

---

gfx

protected gfx: GfxController

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:21

---

overlayName

static overlayName: string = ''

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:17

Methods

clear()

clear(): void

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:38

Returns

void

---

dispose()

dispose(): void

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:40

Returns

void

---

refresh()

refresh(): void

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:42

Returns

void

---

render()

abstract render(ctx, rc): void

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:48

Parameters

ctx

CanvasRenderingContext2D

rc

RoughCanvas

Returns

void

---

setRenderer()

setRenderer(renderer): void

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:50

Parameters

renderer

null | CanvasRenderer

Returns

void

---

setup()

static setup(di): void

Defined in: packages/affine/blocks/block-surface/src/renderer/overlay.ts:25

Parameters

di

Container

Returns

void

Overrides

Extension.setup