Skip to content

BlockSuite API Documentation / @blocksuite/blocks / DatabaseBlockModel

Class: DatabaseBlockModel

Extends

Constructors

new DatabaseBlockModel()

new DatabaseBlockModel(): DatabaseBlockModel

Returns

DatabaseBlockModel

Inherited from

BlockModel<DatabaseBlockProps>.constructor

Defined in

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

Properties

[modelLabel]

[modelLabel]: DatabaseBlockProps

Inherited from

BlockModel.[modelLabel]

Defined in

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


cells

cells: SerializedCells

Inherited from

BlockModel.cells

Defined in

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


cells$

cells$: Signal<SerializedCells>

Inherited from

BlockModel.cells$


childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

BlockModel.childMap

Defined in

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


columns

columns: Column<Record<string, unknown>>[]

Inherited from

BlockModel.columns

Defined in

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


columns$

columns$: Signal<Column<Record<string, unknown>>[]>

Inherited from

BlockModel.columns$


created

created: Slot<void>

Inherited from

BlockModel.created

Defined in

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


deleted

deleted: Slot<void>

Inherited from

BlockModel.deleted

Defined in

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


flavour

flavour: string

Inherited from

BlockModel.flavour

Defined in

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


id

id: string

Inherited from

BlockModel.id

Defined in

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


isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

BlockModel.isEmpty

Defined in

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


keys

keys: string[]

Inherited from

BlockModel.keys

Defined in

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


notes?

optional notes: Record<string, string>

Inherited from

BlockModel.notes

Defined in

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


notes$

notes$: Signal<undefined | Record<string, string>>

Inherited from

BlockModel.notes$


page

page: Doc

Deprecated

use doc instead

Inherited from

BlockModel.page

Defined in

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


pop()

pop: (prop) => void

Parameters

prop: "title" | "notes" | "views" | "cells" | "columns"

Returns

void

Inherited from

BlockModel.pop

Defined in

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


propsUpdated

propsUpdated: Slot<object>

Type declaration

key

key: string

Inherited from

BlockModel.propsUpdated

Defined in

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


role

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

Inherited from

BlockModel.role

Defined in

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


stash()

stash: (prop) => void

Parameters

prop: "title" | "notes" | "views" | "cells" | "columns"

Returns

void

Inherited from

BlockModel.stash

Defined in

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


text?

optional text: Text

Inherited from

BlockModel.text

Defined in

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


title

title: Text

Inherited from

BlockModel.title

Defined in

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


title$

title$: Signal<Text>

Inherited from

BlockModel.title$


version

version: number

Inherited from

BlockModel.version

Defined in

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


views

views: ViewBasicDataType[]

Inherited from

BlockModel.views

Defined in

packages/affine/model/dist/blocks/database/database-model.d.ts:5


views$

views$: Signal<ViewBasicDataType[]>

Inherited from

BlockModel.views$


yBlock

yBlock: YBlock

Inherited from

BlockModel.yBlock

Defined in

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

Accessors

children

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

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

BlockModel.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

BlockModel.doc

Defined in

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


parent

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

BlockModel.parent

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

BlockModel.[dispose]

Defined in

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


dispose()

dispose(): void

Returns

void

Inherited from

BlockModel.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

BlockModel.firstChild

Defined in

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


lastChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

BlockModel.lastChild

Defined in

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