BlockSuite API Documentation / @blocksuite/blocks / FrameBlockModel

Class: FrameBlockModel

Extends

• FrameBlockModel_base

Implements

• GfxElementGeometry
• GfxGroupCompatibleInterface

Constructors

new FrameBlockModel()

new FrameBlockModel(): FrameBlockModel

Returns

FrameBlockModel

Inherited from

FrameBlockModel_base.constructor

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:26

Properties

[gfxGroupCompatibleSymbol]

[gfxGroupCompatibleSymbol]: true

Implementation of

GfxGroupCompatibleInterface.[gfxGroupCompatibleSymbol]

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:29

---

[modelLabel]

[modelLabel]: FrameBlockProps

Inherited from

FrameBlockModel_base.[modelLabel]

Defined in

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

---

background

background: Color

Inherited from

FrameBlockModel_base.background

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:8

---

background$

background$: Signal<Color>

Inherited from

FrameBlockModel_base.background$

---

childElementIds?

optional childElementIds: Record<string, boolean>

Inherited from

FrameBlockModel_base.childElementIds

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:9

---

childElementIds$

childElementIds$: Signal<undefined | Record<string, boolean>>

Inherited from

FrameBlockModel_base.childElementIds$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

FrameBlockModel_base.childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

FrameBlockModel_base.connectable

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:33

---

created

created: Slot<void>

Inherited from

FrameBlockModel_base.created

Defined in

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

---

deleted

deleted: Slot<void>

Inherited from

FrameBlockModel_base.deleted

Defined in

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

---

flavour

flavour: string

Inherited from

FrameBlockModel_base.flavour

Defined in

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

---

id

id: string

Inherited from

FrameBlockModel_base.id

Defined in

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

---

index

index: string

Implementation of

GfxGroupCompatibleInterface.index

Inherited from

FrameBlockModel_base.index

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:13

---

index$

index$: Signal<string>

Inherited from

FrameBlockModel_base.index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

FrameBlockModel_base.isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

FrameBlockModel_base.keys

Defined in

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

---

lockedBySelf?

optional lockedBySelf: boolean

Implementation of

GfxGroupCompatibleInterface.lockedBySelf

Inherited from

FrameBlockModel_base.lockedBySelf

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:14

---

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

FrameBlockModel_base.lockedBySelf$

---

page

page: Doc

Deprecated

use doc instead

Inherited from

FrameBlockModel_base.page

Defined in

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

---

pop()

pop: (prop) => void

Parameters

prop

"xywh" | "index" | "lockedBySelf" | "title" | "background" | "childElementIds" | "presentationIndex"

Returns

void

Inherited from

FrameBlockModel_base.pop

Defined in

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

---

presentationIndex?

optional presentationIndex: string

Inherited from

FrameBlockModel_base.presentationIndex

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:10

---

presentationIndex$

presentationIndex$: Signal<undefined | string>

Inherited from

FrameBlockModel_base.presentationIndex$

---

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

FrameBlockModel_base.propsUpdated

Defined in

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

---

role

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

Inherited from

FrameBlockModel_base.role

Defined in

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

---

rotate

rotate: number

Implementation of

GfxGroupCompatibleInterface.rotate

Inherited from

FrameBlockModel_base.rotate

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:34

---

stash()

stash: (prop) => void

Parameters

prop

"xywh" | "index" | "lockedBySelf" | "title" | "background" | "childElementIds" | "presentationIndex"

Returns

void

Inherited from

FrameBlockModel_base.stash

Defined in

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

---

text?

optional text: Text

Inherited from

FrameBlockModel_base.text

Defined in

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

---

title

title: Text

Inherited from

FrameBlockModel_base.title

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:7

---

title$

title$: Signal<Text>

Inherited from

FrameBlockModel_base.title$

---

version

version: number

Inherited from

FrameBlockModel_base.version

Defined in

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

---

xywh

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

Implementation of

GfxGroupCompatibleInterface.xywh

Inherited from

FrameBlockModel_base.xywh

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:12

---

xywh$

xywh$: Signal<`[${number},${number},${number},${number}]`>

Inherited from

FrameBlockModel_base.xywh$

---

yBlock

yBlock: YBlock

Inherited from

FrameBlockModel_base.yBlock

Defined in

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

Accessors

childElements

Get Signature

get childElements(): GfxModel[]

All child element models of this container. Note that the childElements may not contains all the children in childIds, because some children may not be loaded.

Returns

GfxModel[]

Implementation of

GfxGroupCompatibleInterface.childElements

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:30

---

childIds

Get Signature

get childIds(): string[]

All child ids of this container.

Returns

string[]

Implementation of

GfxGroupCompatibleInterface.childIds

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:31

---

children

Get Signature

get children(): BlockModel<object, SignaledProps<object>>[]

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

FrameBlockModel_base.children

Defined in

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

---

descendantElements

Get Signature

get descendantElements(): GfxModel[]

Returns

GfxModel[]

Implementation of

GfxGroupCompatibleInterface.descendantElements

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:32

---

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Implementation of

GfxGroupCompatibleInterface.deserializedXYWH

Inherited from

FrameBlockModel_base.deserializedXYWH

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:35

---

doc

Get Signature

get doc(): Doc

Returns

Doc

Set Signature

set doc(doc): void

Parameters

doc

Doc

Returns

void

Inherited from

FrameBlockModel_base.doc

Defined in

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

---

elementBound

Get Signature

get elementBound(): Bound

Returns

Bound

Implementation of

GfxGroupCompatibleInterface.elementBound

Inherited from

FrameBlockModel_base.elementBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:36

---

externalBound

Get Signature

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

FrameBlockModel_base.externalBound

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:37

---

externalXYWH

Get Signature

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

Returns

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

Set Signature

set externalXYWH(xywh): void

Parameters

xywh

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

Returns

void

Inherited from

FrameBlockModel_base.externalXYWH

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:38

---

group

Get Signature

get group(): null | GfxGroupModel

Returns

null | GfxGroupModel

Implementation of

GfxGroupCompatibleInterface.group

Inherited from

FrameBlockModel_base.group

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:40

---

groups

Get Signature

get groups(): GfxGroupModel[]

Returns

GfxGroupModel[]

Implementation of

GfxGroupCompatibleInterface.groups

Inherited from

FrameBlockModel_base.groups

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:41

---

h

Get Signature

get h(): number

Returns

number

Implementation of

GfxGroupCompatibleInterface.h

Inherited from

FrameBlockModel_base.h

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:42

---

parent

Get Signature

get parent(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

FrameBlockModel_base.parent

Defined in

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

---

surface

Get Signature

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

FrameBlockModel_base.surface

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:43

---

w

Get Signature

get w(): number

Returns

number

Implementation of

GfxGroupCompatibleInterface.w

Inherited from

FrameBlockModel_base.w

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:44

---

x

Get Signature

get x(): number

Returns

number

Implementation of

GfxGroupCompatibleInterface.x

Inherited from

FrameBlockModel_base.x

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:45

---

y

Get Signature

get y(): number

Returns

number

Implementation of

GfxGroupCompatibleInterface.y

Inherited from

FrameBlockModel_base.y

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:46

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

FrameBlockModel_base.[dispose]

Defined in

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

---

addChild()

addChild(element): void

Parameters

element

GfxModel

Returns

void

Implementation of

GfxGroupCompatibleInterface.addChild

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:33

---

addChildren()

addChildren(elements): void

Parameters

elements

GfxModel[]

Returns

void

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:34

---

containsBound()

containsBound(bound): boolean

Parameters

bound

Bound

Returns

boolean

Implementation of

GfxElementGeometry.containsBound

Overrides

FrameBlockModel_base.containsBound

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:35

---

dispose()

dispose(): void

Returns

void

Inherited from

FrameBlockModel_base.dispose

Defined in

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

---

firstChild()

firstChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

FrameBlockModel_base.firstChild

Defined in

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

---

getLineIntersections()

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

Parameters

start

IVec

end

IVec

Returns

null | PointLocation[]

Implementation of

GfxElementGeometry.getLineIntersections

Inherited from

FrameBlockModel_base.getLineIntersections

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:48

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

point

IVec

Returns

IVec

Implementation of

GfxElementGeometry.getNearestPoint

Inherited from

FrameBlockModel_base.getNearestPoint

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:49

---

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

relativePoint

IVec

Returns

PointLocation

Implementation of

GfxElementGeometry.getRelativePointLocation

Inherited from

FrameBlockModel_base.getRelativePointLocation

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:50

---

hasChild()

hasChild(element): boolean

Parameters

element

GfxModel

Returns

boolean

Implementation of

GfxGroupCompatibleInterface.hasChild

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:36

---

hasDescendant()

hasDescendant(element): boolean

Parameters

element

GfxModel

Returns

boolean

Implementation of

GfxGroupCompatibleInterface.hasDescendant

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:37

---

includesPoint()

includesPoint(x, y, _): boolean

Parameters

x

number

y

number

_

PointTestOptions

Returns

boolean

Implementation of

GfxElementGeometry.includesPoint

Overrides

FrameBlockModel_base.includesPoint

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:38

---

intersectsBound()

intersectsBound(selectedBound): boolean

Parameters

selectedBound

Bound

Returns

boolean

Implementation of

GfxElementGeometry.intersectsBound

Overrides

FrameBlockModel_base.intersectsBound

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:39

---

isLocked()

isLocked(): boolean

Check if the element is locked. It will check the lock status of the element and its ancestors.

Returns

boolean

Implementation of

GfxGroupCompatibleInterface.isLocked

Inherited from

FrameBlockModel_base.isLocked

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:53

---

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Implementation of

GfxGroupCompatibleInterface.isLockedByAncestor

Inherited from

FrameBlockModel_base.isLockedByAncestor

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:54

---

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Implementation of

GfxGroupCompatibleInterface.isLockedBySelf

Inherited from

FrameBlockModel_base.isLockedBySelf

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:55

---

lastChild()

lastChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

FrameBlockModel_base.lastChild

Defined in

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

---

lock()

lock(): void

Returns

void

Implementation of

GfxGroupCompatibleInterface.lock

Inherited from

FrameBlockModel_base.lock

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:56

---

removeChild()

removeChild(element): void

Parameters

element

GfxModel

Returns

void

Implementation of

GfxGroupCompatibleInterface.removeChild

Defined in

packages/affine/model/dist/blocks/frame/frame-model.d.ts:40

---

unlock()

unlock(): void

Returns

void

Implementation of

GfxGroupCompatibleInterface.unlock

Inherited from

FrameBlockModel_base.unlock

Defined in

packages/framework/block-std/dist/gfx/model/gfx-block-model.d.ts:57