Skip to content

BlockSuite API Documentation / @blocksuite/blocks / PageBlockModel

Class: PageBlockModel ​

Contents ​

Extends ​

Constructors ​

new PageBlockModel(undefined) ​

new PageBlockModel(): PageBlockModel

Returns ​

PageBlockModel

Overrides ​

@blocksuite/store.BaseBlockModel.constructor

Source ​

packages/blocks/src/page-block/page-model.ts:9

Properties ​

childrenUpdated ​

childrenUpdated: Slot<void>

Inherited from ​

@blocksuite/store.BaseBlockModel.childrenUpdated

Source ​

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


created ​

created: Slot<void>

Inherited from ​

@blocksuite/store.BaseBlockModel.created

Source ​

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


deleted ​

deleted: Slot<void>

Inherited from ​

@blocksuite/store.BaseBlockModel.deleted

Source ​

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


flavour ​

flavour: string

Inherited from ​

@blocksuite/store.BaseBlockModel.flavour

Source ​

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


id ​

id: string

Inherited from ​

@blocksuite/store.BaseBlockModel.id

Source ​

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


keys ​

keys: string[]

Inherited from ​

@blocksuite/store.BaseBlockModel.keys

Source ​

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


page ​

page: Page

Inherited from ​

@blocksuite/store.BaseBlockModel.page

Source ​

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


pop ​

pop: (prop) => void

Parameters ​

• prop: "title"

Returns ​

void

Inherited from ​

@blocksuite/store.BaseBlockModel.pop

Source ​

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


propsUpdated ​

propsUpdated: Slot<Object>

Type declaration ​

key ​

key: string

Inherited from ​

@blocksuite/store.BaseBlockModel.propsUpdated

Source ​

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


role ​

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

Inherited from ​

@blocksuite/store.BaseBlockModel.role

Source ​

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


stash ​

stash: (prop) => void

Parameters ​

• prop: "title"

Returns ​

void

Inherited from ​

@blocksuite/store.BaseBlockModel.stash

Source ​

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


text? ​

text?: Text

Inherited from ​

@blocksuite/store.BaseBlockModel.text

Source ​

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


title ​

title: Text

Inherited from ​

BaseBlockModel.title

Source ​

packages/blocks/src/page-block/page-model.ts:5


yBlock ​

yBlock: YBlock

Inherited from ​

@blocksuite/store.BaseBlockModel.yBlock

Source ​

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

Accessors ​

childMap ​

get childMap(): Map<string, number>

Returns ​

Map<string, number>

Source ​

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


children ​

get children(): BaseBlockModel<object>[]

Returns ​

BaseBlockModel<object>[]

Source ​

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

Methods ​

clone() ​

clone(): PageBlockModel

Returns ​

PageBlockModel

Inherited from ​

@blocksuite/store.BaseBlockModel.clone

Source ​

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


dispose() ​

dispose(): void

Returns ​

void

Inherited from ​

@blocksuite/store.BaseBlockModel.dispose

Source ​

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


firstChild() ​

firstChild(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Inherited from ​

@blocksuite/store.BaseBlockModel.firstChild

Source ​

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


isEmpty() ​

isEmpty(): boolean

Returns ​

boolean

Inherited from ​

@blocksuite/store.BaseBlockModel.isEmpty

Source ​

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


lastChild() ​

lastChild(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Inherited from ​

@blocksuite/store.BaseBlockModel.lastChild

Source ​

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


lastItem() ​

lastItem(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Inherited from ​

@blocksuite/store.BaseBlockModel.lastItem

Source ​

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


Generated using typedoc-plugin-markdown and TypeDoc