API > @blocksuite/blocks > FrameBlockModel

Class: FrameBlockModel ​

Extends ​

• BaseBlockModel< Props >

Implements ​

• IEdgelessElement

Constructors ​

constructor ​

new FrameBlockModel(): FrameBlockModel

Returns ​

FrameBlockModel

Inherited from ​

BaseBlockModel.constructor

Defined In ​

packages/store/dist/schema/base.d.ts:100

Properties ​

background ​

background: string

Defined In ​

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

Inherited from ​

BaseBlockModel.background

childMap ​

childMap: Map< string, number >

Defined In ​

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

Inherited from ​

BaseBlockModel.childMap

children ​

children: BaseBlockModel< object >[]

Defined In ​

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

Inherited from ​

BaseBlockModel.children

childrenUpdated ​

childrenUpdated: Slot< void >

Defined In ​

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

Inherited from ​

BaseBlockModel.childrenUpdated

created ​

created: Slot< void >

Defined In ​

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

Inherited from ​

BaseBlockModel.created

deleted ​

deleted: Slot< void >

Defined In ​

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

Inherited from ​

BaseBlockModel.deleted

flavour ​

flavour: FRAME

Defined In ​

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

Overrides ​

BaseBlockModel.flavour

getRelativePointLocation ​

getRelativePointLocation: function

Parameters ​

Returns ​

PointLocation

Defined In ​

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

Implementation of ​

IEdgelessElement.getRelativePointLocation

id ​

id: string

Defined In ​

packages/store/dist/schema/base.d.ts:105

Inherited from ​

BaseBlockModel.id

index ​

index: string

Defined In ​

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

Implementation of ​

IEdgelessElement.index

Inherited from ​

BaseBlockModel.index

keys ​

keys: string[]

Defined In ​

packages/store/dist/schema/base.d.ts:107

Inherited from ​

BaseBlockModel.keys

page ​

page: Page

Defined In ​

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

Inherited from ​

BaseBlockModel.page

propsUpdated ​

propsUpdated: Slot< {newProps: unknown; oldProps: unknown;} >

Defined In ​

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

Inherited from ​

BaseBlockModel.propsUpdated

role ​

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

Defined In ​

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

Inherited from ​

BaseBlockModel.role

text ​

optional text: Text

Defined In ​

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

Inherited from ​

BaseBlockModel.text

title ​

title: Text

Defined In ​

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

Inherited from ​

BaseBlockModel.title

xywh ​

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

Defined In ​

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

Implementation of ​

IEdgelessElement.xywh

Inherited from ​

BaseBlockModel.xywh

yBlock ​

yBlock: YBlock

Defined In ​

packages/store/dist/schema/base.d.ts:106

Inherited from ​

BaseBlockModel.yBlock

Accessors ​

batch ​

get batch(): string

Defined In ​

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

Implementation of ​

IEdgelessElement.batch

connectable ​

get connectable(): boolean

Defined In ​

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

Implementation of ​

IEdgelessElement.connectable

gridBound ​

get gridBound(): Bound

Defined In ​

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

Implementation of ​

IEdgelessElement.gridBound

rotate ​

get rotate(): number

Defined In ​

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

Implementation of ​

IEdgelessElement.rotate

Methods ​

boxSelect ​

boxSelect(bound): boolean

Parameters ​

Returns ​

boolean

Implementation of ​

IEdgelessElement.boxSelect

Defined In ​

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

clone ​

clone(): FrameBlockModel

Returns ​

FrameBlockModel

Inherited from ​

BaseBlockModel.clone

Defined In ​

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

containedByBounds ​

containedByBounds(bound): boolean

Parameters ​

Returns ​

boolean

Implementation of ​

IEdgelessElement.containedByBounds

Defined In ​

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

dispose ​

dispose(): void

Returns ​

void

Inherited from ​

BaseBlockModel.dispose

Defined In ​

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

firstChild ​

firstChild(): null | BaseBlockModel< object >

Returns ​

null | BaseBlockModel< object >

Inherited from ​

BaseBlockModel.firstChild

Defined In ​

packages/store/dist/schema/base.d.ts:119

firstItem ​

firstItem(): null | BaseBlockModel< object >

Returns ​

null | BaseBlockModel< object >

Inherited from ​

BaseBlockModel.firstItem

Defined In ​

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

getNearestPoint ​

getNearestPoint(_): IVec

Parameters ​

Returns ​

IVec

Implementation of ​

IEdgelessElement.getNearestPoint

Defined In ​

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

hitTest ​

hitTest( x, y, _): boolean

Parameters ​

Returns ​

boolean

Implementation of ​

IEdgelessElement.hitTest

Defined In ​

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

intersectWithLine ​

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

Parameters ​

Returns ​

null | PointLocation[]

Implementation of ​

IEdgelessElement.intersectWithLine

Defined In ​

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

isEmpty ​

isEmpty(): boolean

Returns ​

boolean

Inherited from ​

BaseBlockModel.isEmpty

Defined In ​

packages/store/dist/schema/base.d.ts:118

lastChild ​

lastChild(): null | BaseBlockModel< object >

Returns ​

null | BaseBlockModel< object >

Inherited from ​

BaseBlockModel.lastChild

Defined In ​

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

lastItem ​

lastItem(): null | BaseBlockModel< object >

Returns ​

null | BaseBlockModel< object >

Inherited from ​

BaseBlockModel.lastItem

Defined In ​

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