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

Class: EdgelessFrameManager

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

Extends

• GfxExtension

Constructors

new EdgelessFrameManager()

new EdgelessFrameManager(gfx): EdgelessFrameManager

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

Parameters

gfx

GfxController

Returns

EdgelessFrameManager

Overrides

GfxExtension.constructor

Properties

gfx

protected readonly gfx: GfxController

Defined in: packages/framework/block-std/dist/gfx/extension.d.ts:13

Inherited from

GfxExtension.gfx

---

key

static key: string = 'frame-manager'

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

Overrides

GfxExtension.key

Accessors

frames

Get Signature

get frames(): FrameBlockModel[]

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

Get all sorted frames by presentation orderer, the legacy frame that uses index as presentation order will be put at the beginning of the array.

Returns

FrameBlockModel[]

---

std

Get Signature

get std(): BlockStdScope

Defined in: packages/framework/block-std/dist/gfx/extension.d.ts:15

Returns

BlockStdScope

Inherited from

GfxExtension.std

Methods

addElementsToFrame()

addElementsToFrame(frame, elements): void

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

Reset parent of elements to the frame

Parameters

frame

FrameBlockModel

elements

GfxModel[]

Returns

void

---

createFrameOnBound()

createFrameOnBound(bound): FrameBlockModel

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

Parameters

bound

Bound

Returns

FrameBlockModel

---

createFrameOnElements()

createFrameOnElements(elements): undefined | FrameBlockModel

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

Parameters

elements

GfxModel[]

Returns

undefined | FrameBlockModel

---

createFrameOnSelected()

createFrameOnSelected(): undefined | FrameBlockModel

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

Returns

undefined | FrameBlockModel

---

createFrameOnViewportCenter()

createFrameOnViewportCenter(wh): void

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

Parameters

wh

[number, number]

Returns

void

---

generatePresentationIndex()

generatePresentationIndex(): string

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

Returns

string

---

getChildElementsInFrame()

getChildElementsInFrame(frame): GfxModel[]

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

Get all elements in the frame, there are three cases:

1. The frame doesn't have childElements, return all elements in the frame bound but not owned by another frame.
2. Return all child elements of the frame if childElements exists.

Parameters

frame

FrameBlockModel

Returns

GfxModel[]

---

getElementsInFrameBound()

getElementsInFrameBound(frame, fullyContained): GfxModel[]

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

Get all elements in the frame bound, whatever the element already has another parent frame or not.

Parameters

frame

FrameBlockModel

fullyContained

boolean = true

Returns

GfxModel[]

---

getFrameFromPoint()

getFrameFromPoint(__namedParameters, ignoreFrames): null | FrameBlockModel

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

Get most top frame from the point.

Parameters

__namedParameters

IVec

ignoreFrames

FrameBlockModel[] = []

Returns

null | FrameBlockModel

---

getParentFrame()

getParentFrame(element): null | FrameBlockModel

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

Parameters

element

GfxModel

Returns

null | FrameBlockModel

---

mounted()

mounted(): void

Defined in: packages/framework/block-std/dist/gfx/extension.d.ts:19

Returns

void

Inherited from

GfxExtension.mounted

---

refreshLegacyFrameOrder()

refreshLegacyFrameOrder(): void

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

This method will populate presentationIndex for all legacy frames, and keep the orderer of the legacy frames.

Returns

void

---

removeAllChildrenFromFrame()

removeAllChildrenFromFrame(frame): void

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

Parameters

frame

FrameBlockModel

Returns

void

---

removeFromParentFrame()

removeFromParentFrame(element): void

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

Parameters

element

GfxModel

Returns

void

---

unmounted()

unmounted(): void

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

Returns

void

Overrides

GfxExtension.unmounted

---

extendGfx()

static extendGfx(_): void

Defined in: packages/framework/block-std/dist/gfx/extension.d.ts:17

Parameters

_

GfxController

Returns

void

Inherited from

GfxExtension.extendGfx

---

framePresentationComparator()

static framePresentationComparator<T>(a, b): -1 | 0 | 1

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

Type Parameters

T

T extends FrameBlockModel | { props: { index: string; presentationIndex: string; }; }

Parameters

a

T

b

T

Returns

-1 | 0 | 1

---

setup()

static setup(di): void

Defined in: packages/framework/block-std/dist/gfx/extension.d.ts:18

Parameters

di

Container

Returns

void

Inherited from

GfxExtension.setup