BlockSuite API Documentation / @blocksuite/affine-model / RootBlockModel

Class: RootBlockModel

Defined in: packages/affine/model/src/blocks/root/root-block-model.ts:12

Extends

• BlockModel<RootBlockProps>

Constructors

new RootBlockModel()

new RootBlockModel(): RootBlockModel

Defined in: packages/affine/model/src/blocks/root/root-block-model.ts:13

Returns

RootBlockModel

Overrides

BlockModel.constructor

Properties

_props

_props: SignaledProps<RootBlockProps>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:33

Inherited from

BlockModel._props

---

[modelLabel]

[modelLabel]: RootBlockProps

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:24

Inherited from

BlockModel.[modelLabel]

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:17

Inherited from

BlockModel.childMap

---

created

created: Subject<void>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:18

Inherited from

BlockModel.created

---

deleted

deleted: Subject<void>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:19

Inherited from

BlockModel.deleted

---

id

id: string

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:20

Inherited from

BlockModel.id

---

keys

keys: string[]

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:23

Inherited from

BlockModel.keys

---

pop()

pop: (prop) => void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:25

Parameters

prop

"title"

Returns

void

Inherited from

BlockModel.pop

---

propsUpdated

propsUpdated: Subject<{ key: string; }>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:26

Inherited from

BlockModel.propsUpdated

---

schema

schema: object

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:21

model

model: object

model.children?

optional model.children: string[]

model.flavour

model.flavour: string

model.isFlatData?

optional model.isFlatData: boolean

model.parent?

optional model.parent: string[]

model.props()?

optional model.props: (args_0, ...args) => Record<string, any>

Parameters

args_0

InternalPrimitives

args

...unknown[]

Returns

Record<string, any>

model.role

model.role: "root" | "hub" | "content"

model.toModel()?

optional model.toModel: (...args) => BlockModel<object>

Parameters

args

...unknown[]

Returns

BlockModel<object>

transformer()?

optional transformer: (args_0, ...args) => BaseBlockTransformer<object>

Parameters

args_0

Map<string, unknown>

args

...unknown[]

Returns

BaseBlockTransformer<object>

version

version: number

Inherited from

BlockModel.schema

---

stash()

stash: (prop) => void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:29

Parameters

prop

"title"

Returns

void

Inherited from

BlockModel.stash

---

yBlock

yBlock: YBlock

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:32

Inherited from

BlockModel.yBlock

Accessors

children

Get Signature

get children(): BlockModel<object>[]

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:37

Returns

BlockModel<object>[]

Inherited from

BlockModel.children

---

doc

Get Signature

get doc(): Store

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:38

Returns

Store

Set Signature

set doc(doc): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:39

Parameters

doc

Store

Returns

void

Inherited from

BlockModel.doc

---

flavour

Get Signature

get flavour(): string

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:35

Returns

string

Inherited from

BlockModel.flavour

---

parent

Get Signature

get parent(): null | BlockModel<object>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:40

Returns

null | BlockModel<object>

Inherited from

BlockModel.parent

---

props

Get Signature

get props(): SignaledProps<Props>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:34

Returns

SignaledProps<Props>

Inherited from

BlockModel.props

---

role

Get Signature

get role(): "root" | "hub" | "content"

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:41

Returns

"root" | "hub" | "content"

Inherited from

BlockModel.role

---

text

Get Signature

get text(): undefined | Text

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:30

Returns

undefined | Text

Set Signature

set text(text): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:31

Parameters

text

Text

Returns

void

Inherited from

BlockModel.text

---

version

Get Signature

get version(): number

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:36

Returns

number

Inherited from

BlockModel.version

Methods

[dispose]()

[dispose](): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:46

Returns

void

Inherited from

BlockModel.[dispose]

---

dispose()

dispose(): void

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:43

Returns

void

Inherited from

BlockModel.dispose

---

firstChild()

firstChild(): null | BlockModel<object>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:44

Returns

null | BlockModel<object>

Inherited from

BlockModel.firstChild

---

isEmpty()

isEmpty(): boolean

Defined in: packages/affine/model/src/blocks/root/root-block-model.ts:37

A page is empty if it only contains one empty note and the canvas is empty

Returns

boolean

Overrides

BlockModel.isEmpty

---

lastChild()

lastChild(): null | BlockModel<object>

Defined in: packages/framework/store/dist/model/block/block-model.d.ts:45

Returns

null | BlockModel<object>

Inherited from

BlockModel.lastChild