BlockSuite API Documentation / @blocksuite/blocks / FrameOverlay

Class: FrameOverlay

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

Extends

• Overlay

Constructors

new FrameOverlay()

new FrameOverlay(gfx): FrameOverlay

Parameters

gfx

GfxController

Returns

FrameOverlay

Overrides

Overlay.constructor

Defined in

packages/blocks/src/root-block/edgeless/frame-manager.ts:50

Properties

_renderer

protected _renderer: null | CanvasRenderer

Inherited from

Overlay._renderer

Defined in

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

---

gfx

protected gfx: GfxController

Inherited from

Overlay.gfx

Defined in

packages/affine/block-surface/dist/renderer/overlay.d.ts:11

---

overlayName

static overlayName: string = 'frame'

Overrides

Overlay.overlayName

Defined in

packages/blocks/src/root-block/edgeless/frame-manager.ts:34

Methods

clear()

clear(): void

Returns

void

Overrides

Overlay.clear

Defined in

packages/blocks/src/root-block/edgeless/frame-manager.ts:62

---

dispose()

dispose(): void

Returns

void

Inherited from

Overlay.dispose

Defined in

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

---

highlight()

highlight(frame, highlightElementsInBound, highlightOutline): void

Parameters

frame

FrameBlockModel

highlightElementsInBound

boolean = false

highlightOutline

boolean = true

Returns

void

Defined in

packages/blocks/src/root-block/edgeless/frame-manager.ts:68

---

refresh()

refresh(): void

Returns

void

Inherited from

Overlay.refresh

Defined in

packages/affine/block-surface/dist/renderer/overlay.d.ts:18

---

render()

render(ctx): void

Parameters

ctx

CanvasRenderingContext2D

Returns

void

Overrides

Overlay.render

Defined in

packages/blocks/src/root-block/edgeless/frame-manager.ts:111

---

setRenderer()

setRenderer(renderer): void

Parameters

renderer

null | CanvasRenderer

Returns

void

Inherited from

Overlay.setRenderer

Defined in

packages/affine/block-surface/dist/renderer/overlay.d.ts:20

---

setup()

static setup(di): void

Parameters

di

Container

Returns

void

Inherited from

Overlay.setup

Defined in

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