Skip to content

BlockSuite API Documentation / @blocksuite/blocks / DatabaseService

Class: DatabaseService<TextAttributes>

Extends

Type parameters

TextAttributes extends AffineTextAttributes = AffineTextAttributes

Constructors

new DatabaseService(options)

new DatabaseService<TextAttributes>(options): DatabaseService<TextAttributes>

Parameters

options: BlockServiceOptions

Returns

DatabaseService<TextAttributes>

Inherited from

@blocksuite/block-std.BlockService.constructor

Source

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

Properties

disposables

readonly disposables: DisposableGroup

Inherited from

@blocksuite/block-std.BlockService.disposables

Source

packages/framework/block-std/dist/service/index.d.ts:14


flavour

readonly flavour: string

Inherited from

@blocksuite/block-std.BlockService.flavour

Source

packages/framework/block-std/dist/service/index.d.ts:13


inlineManager

readonly inlineManager: InlineManager<TextAttributes>

Source

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


referenceNodeConfig

readonly referenceNodeConfig: ReferenceNodeConfig

Source

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


specSlots

readonly specSlots: BlockSpecSlots

Inherited from

@blocksuite/block-std.BlockService.specSlots

Source

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


std

readonly std: BlockStdScope

Inherited from

@blocksuite/block-std.BlockService.std

Source

packages/framework/block-std/dist/service/index.d.ts:12

Accessors

page

get page(): Page

Returns

Page

Source

packages/framework/block-std/dist/service/index.d.ts:18


selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Source

packages/framework/block-std/dist/service/index.d.ts:19


uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Source

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


workspace

get workspace(): Workspace

Returns

Workspace

Source

packages/framework/block-std/dist/service/index.d.ts:17

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

keymap: Record<string, UIEventHandler>

options?: Object

options.global?: boolean

Returns

void

Inherited from

@blocksuite/block-std.BlockService.bindHotKey

Source

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


dispose()

dispose(): void

Returns

void

Inherited from

@blocksuite/block-std.BlockService.dispose

Source

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


handleEvent()

handleEvent(name, fn, options?): void

Parameters

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

fn: UIEventHandler

options?: Object

options.global?: boolean

Returns

void

Inherited from

@blocksuite/block-std.BlockService.handleEvent

Source

packages/framework/block-std/dist/service/index.d.ts:24


initDatabaseBlock()

initDatabaseBlock(page, model, databaseId, viewType, isAppendNewRow): void

Parameters

page: Page

model: BlockModel<object>

databaseId: string

viewType: "table" | "kanban"

isAppendNewRow: boolean= true

Returns

void

Source

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


mounted()

mounted(): void

Returns

void

Overrides

@blocksuite/block-std.BlockService.mounted

Source

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


unmounted()

unmounted(): void

Returns

void

Inherited from

@blocksuite/block-std.BlockService.unmounted

Source

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


Generated using TypeDoc and typedoc-plugin-markdown.