BlockSuite API Documentation / @blocksuite/blocks / DatabaseBlockService

Class: DatabaseBlockService

Deprecated

BlockService is deprecated. You should reconsider where to put your feature.

BlockService is a legacy extension that is used to provide services to the block. In the previous version of BlockSuite, block service provides a way to extend the block. However, in the new version, we recommend using the new extension system.

Extends

• BlockService

Constructors

new DatabaseBlockService()

new DatabaseBlockService(std, flavourProvider): DatabaseBlockService

Parameters

• std: BlockStdScope

• flavourProvider

• flavourProvider.flavour: string

Returns

DatabaseBlockService

Inherited from

BlockService.constructor

Defined in

packages/framework/block-std/dist/extension/service.d.ts:23

Properties

addColumn()

addColumn: (model, position, column) => string

Parameters

• model: DatabaseBlockModel

• position: InsertToPosition

• column: Omit<Column<Record<string, unknown>>, "id"> & object

Returns

string

Defined in

packages/blocks/src/database-block/database-service.ts:33

---

applyColumnUpdate()

applyColumnUpdate: (model) => void

Parameters

• model: DatabaseBlockModel

Returns

void

Defined in

packages/blocks/src/database-block/database-service.ts:35

---

databaseViewAddView()

databaseViewAddView: (model, viewMeta) => BasicViewDataType<"table", DataType> | BasicViewDataType<"kanban", DataType>

Parameters

• model: DatabaseBlockModel

• viewMeta: ViewMeta

Returns

BasicViewDataType<"table", DataType> | BasicViewDataType<"kanban", DataType>

Defined in

packages/blocks/src/database-block/database-service.ts:37

---

databaseViewInitEmpty()

databaseViewInitEmpty: (model, viewMeta) => void

Parameters

• model: DatabaseBlockModel

• viewMeta: ViewMeta

Returns

void

Defined in

packages/blocks/src/database-block/database-service.ts:39

---

disposables

readonly disposables: DisposableGroup

Inherited from

BlockService.disposables

Defined in

packages/framework/block-std/dist/extension/service.d.ts:20

---

flavour

readonly flavour: string

Inherited from

BlockService.flavour

Defined in

packages/framework/block-std/dist/extension/service.d.ts:21

---

flavourProvider

readonly flavourProvider: object

flavour

flavour: string

Inherited from

BlockService.flavourProvider

Defined in

packages/framework/block-std/dist/extension/service.d.ts:16

---

inlineManager

readonly inlineManager: InlineManager<object>

Type declaration

bold?

optional bold: null | true

code?

optional code: null | true

italic?

optional italic: null | true

link?

optional link: null | string

strike?

optional strike: null | true

underline?

optional underline: null | true

Defined in

packages/blocks/src/database-block/database-service.ts:41

---

referenceNodeConfig

readonly referenceNodeConfig: ReferenceNodeConfig

Defined in

packages/blocks/src/database-block/database-service.ts:43

---

specSlots

readonly specSlots: BlockSpecSlots<BlockService>

Inherited from

BlockService.specSlots

Defined in

packages/framework/block-std/dist/extension/service.d.ts:22

---

std

readonly std: BlockStdScope

Inherited from

BlockService.std

Defined in

packages/framework/block-std/dist/extension/service.d.ts:15

---

updateCell()

updateCell: (model, rowId, cell) => void

Parameters

• model: DatabaseBlockModel

• rowId: string

• cell: Cell

Returns

void

Defined in

packages/blocks/src/database-block/database-service.ts:45

---

updateView()

updateView: <ViewData>(model, id, update) => void

Type Parameters

• ViewData extends ViewBasicDataType

Parameters

• model: DatabaseBlockModel

• id: string

• update

Returns

void

Defined in

packages/blocks/src/database-block/database-service.ts:47

---

viewPresets

viewPresets: object

kanbanViewConfig

kanbanViewConfig: object

kanbanViewConfig.model

kanbanViewConfig.model: DataViewConfig<KanbanViewData>

kanbanViewConfig.renderer

kanbanViewConfig.renderer: DataViewRendererConfig

kanbanViewConfig.type

kanbanViewConfig.type: "kanban"

tableViewConfig

tableViewConfig: object

tableViewConfig.model

tableViewConfig.model: DataViewConfig<TableViewData>

tableViewConfig.renderer

tableViewConfig.renderer: DataViewRendererConfig

tableViewConfig.type

tableViewConfig.type: "table"

Defined in

packages/blocks/src/database-block/database-service.ts:49

---

flavour

readonly static flavour: "affine:database" = DatabaseBlockSchema.model.flavour

Overrides

BlockService.flavour

Defined in

packages/blocks/src/database-block/database-service.ts:31

Accessors

collection

get collection(): DocCollection

Returns

DocCollection

Inherited from

BlockService.collection

Defined in

packages/framework/block-std/dist/extension/service.d.ts:36

---

doc

get doc(): Doc

Returns

Doc

Inherited from

BlockService.doc

Defined in

packages/framework/block-std/dist/extension/service.d.ts:37

---

host

get host(): EditorHost

Returns

EditorHost

Inherited from

BlockService.host

Defined in

packages/framework/block-std/dist/extension/service.d.ts:38

---

selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Inherited from

BlockService.selectionManager

Defined in

packages/framework/block-std/dist/extension/service.d.ts:39

---

uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Inherited from

BlockService.uiEventDispatcher

Defined in

packages/framework/block-std/dist/extension/service.d.ts:40

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

• keymap: Record<string, UIEventHandler>

• options?

• options.global?: boolean

Returns

void

Inherited from

BlockService.bindHotKey

Defined in

packages/framework/block-std/dist/extension/service.d.ts:27

---

dispose()

dispose(): void

Returns

void

Inherited from

BlockService.dispose

Defined in

packages/framework/block-std/dist/extension/service.d.ts:30

---

handleEvent()

handleEvent(name, fn, options?): void

Parameters

• name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "blur" | "focus" | "drop" | "contextMenu" | "wheel"

• fn: UIEventHandler

• options?

• options.global?: boolean

Returns

void

Inherited from

BlockService.handleEvent

Defined in

packages/framework/block-std/dist/extension/service.d.ts:31

---

initDatabaseBlock()

initDatabaseBlock(doc, model, databaseId, viewMeta, isAppendNewRow): void

Parameters

• doc: Doc

• model: BlockModel<object, SignaledProps<object>>

• databaseId: string

• viewMeta: ViewMeta

• isAppendNewRow: boolean = true

Returns

void

Defined in

packages/blocks/src/database-block/database-service.ts:51

---

mounted()

mounted(): void

Returns

void

Overrides

BlockService.mounted

Defined in

packages/blocks/src/database-block/database-service.ts:70

---

unmounted()

unmounted(): void

Returns

void

Inherited from

BlockService.unmounted

Defined in

packages/framework/block-std/dist/extension/service.d.ts:35

---

setup()

static setup(di): void

Parameters

• di: Container

Returns

void

Inherited from

BlockService.setup

Defined in

packages/framework/block-std/dist/extension/service.d.ts:26