BlockSuite API Documentation / @blocksuite/blocks / FrameBlockModel

Class: FrameBlockModel

Extends

• EdgelessBlock<FrameBlockProps, this>

Constructors

new FrameBlockModel(undefined)

new FrameBlockModel(): FrameBlockModel

Returns

FrameBlockModel

Inherited from

EdgelessBlock.constructor

Source

packages/framework/store/dist/schema/base.d.ts:99

Properties

[modelLabel]

[modelLabel]: FrameBlockProps

Inherited from

EdgelessBlock.[modelLabel]

Source

packages/framework/store/dist/schema/base.d.ts:101

---

background

background: string

Inherited from

selectable<FrameBlockProps>(BlockModel).background

Source

packages/blocks/src/frame-block/frame-model.ts:13

---

childrenUpdated

childrenUpdated: Slot<void>

Inherited from

EdgelessBlock.childrenUpdated

Source

packages/framework/store/dist/schema/base.d.ts:120

---

connectable

connectable: boolean = true

Inherited from

EdgelessBlock.connectable

Source

packages/blocks/src/root-block/edgeless/type.ts:74

---

created

created: Slot<void>

Inherited from

EdgelessBlock.created

Source

packages/framework/store/dist/schema/base.d.ts:115

---

deleted

deleted: Slot<void>

Inherited from

EdgelessBlock.deleted

Source

packages/framework/store/dist/schema/base.d.ts:116

---

flavour

flavour: string

Inherited from

EdgelessBlock.flavour

Source

packages/framework/store/dist/schema/base.d.ts:103

---

id

id: string

Inherited from

EdgelessBlock.id

Source

packages/framework/store/dist/schema/base.d.ts:109

---

index

index: string

Inherited from

EdgelessBlock.index

Source

packages/blocks/src/frame-block/frame-model.ts:15

---

keys

keys: string[]

Inherited from

EdgelessBlock.keys

Source

packages/framework/store/dist/schema/base.d.ts:111

---

page

page: Doc

Deprecated

use doc instead

Inherited from

EdgelessBlock.page

Source

packages/framework/store/dist/schema/base.d.ts:108

---

pop

pop: (prop) => void

Parameters

• prop: "xywh" | "index" | "title" | "background"

Returns

void

Inherited from

EdgelessBlock.pop

Source

packages/framework/store/dist/schema/base.d.ts:113

---

propsUpdated

propsUpdated: Slot<Object>

Type declaration

key

key: string

Inherited from

EdgelessBlock.propsUpdated

Source

packages/framework/store/dist/schema/base.d.ts:117

---

role

role: "root" | "hub" | "content"

Inherited from

EdgelessBlock.role

Source

packages/framework/store/dist/schema/base.d.ts:104

---

rotate

rotate: number = 0

Inherited from

EdgelessBlock.rotate

Source

packages/blocks/src/root-block/edgeless/type.ts:75

---

stash

stash: (prop) => void

Parameters

• prop: "xywh" | "index" | "title" | "background"

Returns

void

Inherited from

EdgelessBlock.stash

Source

packages/framework/store/dist/schema/base.d.ts:112

---

text?

optional text: Text

Inherited from

EdgelessBlock.text

Source

packages/framework/store/dist/schema/base.d.ts:114

---

title

title: Text

Inherited from

selectable<FrameBlockProps>(BlockModel).title

Source

packages/blocks/src/frame-block/frame-model.ts:12

---

version

version: number

Inherited from

EdgelessBlock.version

Source

packages/framework/store/dist/schema/base.d.ts:102

---

xywh

xywh: `[${number},${number},${number},${number}]`

Inherited from

EdgelessBlock.xywh

Source

packages/blocks/src/frame-block/frame-model.ts:14

---

yBlock

yBlock: YBlock

Inherited from

EdgelessBlock.yBlock

Source

packages/framework/store/dist/schema/base.d.ts:110

---

PADDING

static PADDING: number[]

Source

packages/blocks/src/frame-block/frame-model.ts:38

Accessors

childMap

get childMap(): Map<string, number>

Returns

Map<string, number>

Source

packages/framework/store/dist/schema/base.d.ts:123

---

children

get children(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/framework/store/dist/schema/base.d.ts:124

---

doc

get doc(): Doc

set doc(doc): void

Parameters

• doc: Doc

Returns

Doc

Source

packages/framework/store/dist/schema/base.d.ts:121

---

elementBound

get elementBound(): Bound

Returns

Bound

Source

packages/blocks/src/root-block/edgeless/type.ts:91

---

externalBound

get externalBound(): null | Bound

Returns

null | Bound

Source

packages/blocks/src/root-block/edgeless/type.ts:87

---

externalXYWH

get externalXYWH(): undefined | `[${number},${number},${number},${number}]`

set externalXYWH(xywh): void

Parameters

• xywh: undefined | `[${number},${number},${number},${number}]`

Returns

undefined | `[${number},${number},${number},${number}]`

Source

packages/blocks/src/root-block/edgeless/type.ts:79

---

group

get group(): null | GroupElementModel

Returns

null | GroupElementModel

Source

packages/blocks/src/root-block/edgeless/type.ts:153

---

groups

get groups(): GroupElementModel[]

Returns

GroupElementModel[]

Source

packages/blocks/src/root-block/edgeless/type.ts:161

Methods

boxSelect()

boxSelect(seclectedBound): boolean

Parameters

• seclectedBound: Bound

Returns

boolean

Overrides

EdgelessBlock.boxSelect

Source

packages/blocks/src/frame-block/frame-model.ts:68

---

containedByBounds()

containedByBounds(bounds): boolean

Parameters

• bounds: Bound

Returns

boolean

Inherited from

EdgelessBlock.containedByBounds

Source

packages/blocks/src/root-block/edgeless/type.ts:101

---

dispose()

dispose(): void

Returns

void

Inherited from

EdgelessBlock.dispose

Source

packages/framework/store/dist/schema/base.d.ts:129

---

firstChild()

firstChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

EdgelessBlock.firstChild

Source

packages/framework/store/dist/schema/base.d.ts:126

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Inherited from

EdgelessBlock.getNearestPoint

Source

packages/blocks/src/root-block/edgeless/type.ts:113

---

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

• relativePoint: IVec

Returns

PointLocation

Inherited from

EdgelessBlock.getRelativePointLocation

Source

packages/blocks/src/root-block/edgeless/type.ts:130

---

hitTest()

hitTest(x, y, _, host): boolean

Parameters

• x: number

• y: number

• _: HitTestOptions

• host: EditorHost

Returns

boolean

Overrides

EdgelessBlock.hitTest

Source

packages/blocks/src/frame-block/frame-model.ts:40

---

intersectWithLine()

intersectWithLine(start, end): null | PointLocation[]

Parameters

• start: IVec

• end: IVec

Returns

null | PointLocation[]

Inherited from

EdgelessBlock.intersectWithLine

Source

packages/blocks/src/root-block/edgeless/type.ts:121

---

isEmpty()

isEmpty(): boolean

Returns

boolean

Inherited from

EdgelessBlock.isEmpty

Source

packages/framework/store/dist/schema/base.d.ts:125

---

lastChild()

lastChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

EdgelessBlock.lastChild

Source

packages/framework/store/dist/schema/base.d.ts:127

---

lastItem()

lastItem(): null | BlockModel<object>

Returns

null | BlockModel<object>

Inherited from

EdgelessBlock.lastItem

Source

packages/framework/store/dist/schema/base.d.ts:128