BlockSuite API Documentation / @blocksuite/affine-block-frame / FrameOverlay

Class: FrameOverlay

Defined in: packages/affine/blocks/block-frame/src/frame-manager.ts:31

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

Defined in: packages/affine/blocks/block-frame/src/frame-manager.ts:46

Parameters

gfx

GfxController

Returns

FrameOverlay

Overrides

Overlay.constructor

Properties

_renderer

protected _renderer: null | CanvasRenderer

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

Inherited from

Overlay._renderer

---

gfx

protected gfx: GfxController

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

Inherited from

Overlay.gfx

---

overlayName

static overlayName: string = 'frame'

Defined in: packages/affine/blocks/block-frame/src/frame-manager.ts:32

Overrides

Overlay.overlayName

Methods

clear()

clear(): void

Defined in: packages/affine/blocks/block-frame/src/frame-manager.ts:58

Returns

void

Overrides

Overlay.clear

---

dispose()

dispose(): void

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

Returns

void

Inherited from

Overlay.dispose

---

highlight()

highlight(frame, highlightElementsInBound, highlightOutline): void

Defined in: packages/affine/blocks/block-frame/src/frame-manager.ts:64

Parameters

frame

FrameBlockModel

highlightElementsInBound

boolean = false

highlightOutline

boolean = true

Returns

void

---

refresh()

refresh(): void

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

Returns

void

Inherited from

Overlay.refresh

---

render()

render(ctx): void

Defined in: packages/affine/blocks/block-frame/src/frame-manager.ts:108

Parameters

ctx

CanvasRenderingContext2D

Returns

void

Overrides

Overlay.render

---

setRenderer()

setRenderer(renderer): void

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

Parameters

renderer

null | CanvasRenderer

Returns

void

Inherited from

Overlay.setRenderer

---

setup()

static setup(di): void

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

Parameters

di

Container

Returns

void

Inherited from

Overlay.setup