BlockSuite API Documentation / @blocksuite/blocks / FrameBlockModel

Class: FrameBlockModel

Extends

FrameBlockModel_base

Implements

GfxElementGeometry
GfxContainerElement

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:27

Properties

[gfxContainerSymbol]

[gfxContainerSymbol]: true

Implementation of

GfxContainerElement.[gfxContainerSymbol]

Defined in

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

[modelLabel]

[modelLabel]: FrameBlockProps

Inherited from

FrameBlockModel_base.[modelLabel]

Defined in

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

background

background: Color

Inherited from

FrameBlockModel_base.background

Defined in

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

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:10

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:109

connectable

connectable: boolean

Inherited from

FrameBlockModel_base.connectable

Defined in

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

created

created: Slot<void>

Inherited from

FrameBlockModel_base.created

Defined in

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

deleted

deleted: Slot<void>

Inherited from

FrameBlockModel_base.deleted

Defined in

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

flavour

flavour: string

Inherited from

FrameBlockModel_base.flavour

Defined in

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

id

id: string

Inherited from

FrameBlockModel_base.id

Defined in

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

index

index: string

Implementation of

GfxContainerElement.index

Inherited from

FrameBlockModel_base.index

Defined in

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

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:114

keys

keys: string[]

Inherited from

FrameBlockModel_base.keys

Defined in

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

pop()

pop: (prop) => void

Parameters

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

Returns

void

Inherited from

FrameBlockModel_base.pop

Defined in

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

propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

FrameBlockModel_base.propsUpdated

Defined in

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

role

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

Inherited from

FrameBlockModel_base.role

Defined in

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

rotate

rotate: number

Inherited from

FrameBlockModel_base.rotate

Defined in

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

stash()

stash: (prop) => void

Parameters

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

Returns

void

Inherited from

FrameBlockModel_base.stash

Defined in

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

text?

optional text: Text

Inherited from

FrameBlockModel_base.text

Defined in

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

title

title: Text

Inherited from

FrameBlockModel_base.title

Defined in

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

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:128

xywh

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

Implementation of

GfxContainerElement.xywh

Inherited from

FrameBlockModel_base.xywh

Defined in

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

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:129

Accessors

childElements

get childElements(): GfxModel[]

Returns

GfxModel[]

Implementation of

GfxContainerElement.childElements

Defined in

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

childIds

get childIds(): string[]

Returns

string[]

Implementation of

GfxContainerElement.childIds

Defined in

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

children

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:130

doc

get doc(): Doc

set doc(doc): void

Parameters

• doc: Doc

Returns

Doc

Inherited from

FrameBlockModel_base.doc

Defined in

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

elementBound

get elementBound(): Bound

Returns

Bound

Inherited from

FrameBlockModel_base.elementBound

Defined in

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

externalBound

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

FrameBlockModel_base.externalBound

Defined in

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

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}]`

Inherited from

FrameBlockModel_base.externalXYWH

Defined in

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

group

get group(): null | SurfaceGroupLikeModel<BaseElementProps>

Returns

null | SurfaceGroupLikeModel<BaseElementProps>

Inherited from

FrameBlockModel_base.group

Defined in

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

groups

get groups(): SurfaceGroupLikeModel<BaseElementProps>[]

Returns

SurfaceGroupLikeModel<BaseElementProps>[]

Inherited from

FrameBlockModel_base.groups

Defined in

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

parent

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:133

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

FrameBlockModel_base.[dispose]

Defined in

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

addChild()

addChild(element): void

Parameters

• element: string | GfxModel

Returns

void

Defined in

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

addChildren()

addChildren(elements): void

Parameters

• elements: (string | 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:135

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:136

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/gfx-block-model.d.ts:17

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/gfx-block-model.d.ts:18

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/gfx-block-model.d.ts:19

hasDescendant()

hasDescendant(element): boolean

Parameters

• element: string | GfxModel

Returns

boolean

Implementation of

GfxContainerElement.hasDescendant

Defined in

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

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:37

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:38

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:137

removeChild()

removeChild(element): void

Parameters

• element: string | GfxModel

Returns

void

Defined in

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

Class: FrameBlockModel ​

Extends ​

Implements ​

Constructors ​

new FrameBlockModel() ​

Returns ​

Inherited from ​

Defined in ​

Properties ​

[gfxContainerSymbol] ​

Implementation of ​

Defined in ​

[modelLabel] ​

Inherited from ​

Defined in ​

background ​

Inherited from ​

Defined in ​

background$ ​

Inherited from ​

childElementIds? ​

Inherited from ​

Defined in ​

childElementIds$ ​

Inherited from ​

childMap ​

Inherited from ​

Defined in ​

connectable ​

Inherited from ​

Defined in ​

created ​

Inherited from ​

Defined in ​

deleted ​

Inherited from ​

Defined in ​

flavour ​

Inherited from ​

Defined in ​

id ​

Inherited from ​

Defined in ​

index ​

Implementation of ​

Inherited from ​

Defined in ​

index$ ​

Inherited from ​

isEmpty ​

Inherited from ​

Defined in ​

keys ​

Inherited from ​

Defined in ​

page ​

Deprecated ​

Inherited from ​

Defined in ​

pop() ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

propsUpdated ​

Type declaration ​

key ​

Inherited from ​

Defined in ​

role ​

Inherited from ​

Defined in ​

rotate ​

Inherited from ​

Defined in ​

stash() ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

Class: FrameBlockModel

Extends

Implements

Constructors

new FrameBlockModel()

Returns

Inherited from

Defined in

Properties

[gfxContainerSymbol]

Implementation of

Defined in

[modelLabel]

Inherited from

Defined in

background

Inherited from

Defined in

background$

Inherited from

childElementIds?

Inherited from

Defined in

childElementIds$

Inherited from

childMap

Inherited from

Defined in

connectable

Inherited from

Defined in

created

Inherited from

Defined in

deleted

Inherited from

Defined in

flavour

Inherited from

Defined in

id

Inherited from

Defined in

index

Implementation of

Inherited from

Defined in

index$

Inherited from

isEmpty

Inherited from

Defined in

keys

Inherited from

Defined in

page

Deprecated

Inherited from

Defined in

pop()

Parameters

Returns

Inherited from

Defined in

propsUpdated

Type declaration

key

Inherited from

Defined in

role

Inherited from

Defined in

rotate

Inherited from

Defined in

stash()

Parameters

Returns

Inherited from

Defined in