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

Class: ConnectionOverlay

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:846

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

Extends

• Overlay

Constructors

new ConnectionOverlay()

new ConnectionOverlay(gfx): ConnectionOverlay

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:861

Parameters

gfx

GfxController

Returns

ConnectionOverlay

Overrides

Overlay.constructor

Properties

_renderer

protected _renderer: null | CanvasRenderer = null

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

Inherited from

Overlay._renderer

---

gfx

protected gfx: GfxController

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

Inherited from

Overlay.gfx

---

highlightPoint

highlightPoint: null | IVec = null

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:853

---

points

points: IVec[] = []

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:855

---

sourceBounds

sourceBounds: null | IBound = null

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:857

---

targetBounds

targetBounds: null | IBound = null

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:859

---

overlayName

static overlayName: string = 'connection'

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:847

Overrides

Overlay.overlayName

Methods

_clearRect()

_clearRect(): void

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:887

Returns

void

---

clear()

clear(): void

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:893

Returns

void

Overrides

Overlay.clear

---

dispose()

dispose(): void

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:899

Returns

void

Overrides

Overlay.dispose

---

refresh()

refresh(): void

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

Returns

void

Inherited from

Overlay.refresh

---

render()

render(ctx): void

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:906

Parameters

ctx

CanvasRenderingContext2D

Returns

void

Overrides

Overlay.render

---

renderConnector()

renderConnector(point, excludedIds): Connection

Defined in: packages/affine/blocks/block-surface/src/managers/connector-manager.ts:953

Render the connector at the given point. It will try to find the closest connectable element and render the connector. If the point is not close to any connectable element, it will just render the connector at the given point.

Parameters

point

IVec

the point to render the connector

excludedIds

string[] = []

the ids of the elements that should be excluded

Returns

Connection

the connection result

---

setRenderer()

setRenderer(renderer): void

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

Parameters

renderer

null | CanvasRenderer

Returns

void

Inherited from

Overlay.setRenderer

---

setup()

static setup(di): void

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

Parameters

di

Container

Returns

void

Inherited from

Overlay.setup