BlockSuite API Documentation / @blocksuite/affine-block-table

@blocksuite/affine-block-table

Classes

TableDataManager

Constructors

Constructor

new TableDataManager(model): TableDataManager

Parameters

model

TableBlockModel

Returns

TableDataManager

Properties

cellCountTips$

readonly cellCountTips$: ReadonlySignal<string>

columns$

readonly columns$: ReadonlySignal<TableColumn[]>

hoverColumnIndex$

readonly hoverColumnIndex$: Signal<number | undefined>

hoverDragHandleColumnId$

readonly hoverDragHandleColumnId$: Signal<string | undefined>

hoverRowIndex$

readonly hoverRowIndex$: Signal<number | undefined>

readonly$

readonly readonly$: ReadonlySignal<boolean>

rows$

readonly rows$: ReadonlySignal<TableRow[]>

ui

readonly ui: object

columnIndicatorIndex$

columnIndicatorIndex$: Signal<number | undefined>

rowIndicatorIndex$

rowIndicatorIndex$: Signal<number | undefined>

uiColumns$

readonly uiColumns$: ReadonlySignal<(TableColumn | { backgroundColor: undefined; columnId: string; width: undefined; })[]>

uiRows$

readonly uiRows$: ReadonlySignal<(TableRow | { backgroundColor: undefined; rowId: string; })[]>

virtualColumnCount$

readonly virtualColumnCount$: Signal<number>

virtualRowCount$

readonly virtualRowCount$: Signal<number>

virtualWidth$

readonly virtualWidth$: Signal<{ columnId: string; width: number; } | undefined>

widthAdjustColumnId$

readonly widthAdjustColumnId$: Signal<string | undefined>

Methods

addColumn()

addColumn(after?): string

Parameters

after?

number

Returns

string

addNColumn()

addNColumn(count): void

Parameters

count

number

Returns

void

addNRow()

addNRow(count): void

Parameters

count

number

Returns

void

addRow()

addRow(after?): string

Parameters

after?

number

Returns

string

clearCells()

clearCells(cells): void

Parameters

cells

object[]

Returns

void

clearCellsBySelection()

clearCellsBySelection(selection): void

Parameters

selection

columnEndIndex

number = ...

columnStartIndex

number = ...

rowEndIndex

number = ...

rowStartIndex

number = ...

type

"area" = ...

Returns

void

clearColumn()

clearColumn(columnId): void

Parameters

columnId

string

Returns

void

clearRow()

clearRow(rowId): void

Parameters

rowId

string

Returns

void

deleteColumn()

deleteColumn(columnId): void

Parameters

columnId

string

Returns

void

deleteRow()

deleteRow(rowId): void

Parameters

rowId

string

Returns

void

duplicateColumn()

duplicateColumn(index): string | undefined

Parameters

index

number

Returns

string | undefined

duplicateRow()

duplicateRow(index): string | undefined

Parameters

index

number

Returns

string | undefined

getCell()

getCell(rowId, columnId): TableCell | undefined

Parameters

rowId

string

columnId

string

Returns

TableCell | undefined

insertColumn()

insertColumn(after?): void

Parameters

after?

number

Returns

void

insertRow()

insertRow(after?): void

Parameters

after?

number

Returns

void

moveColumn()

moveColumn(from, after?): void

Parameters

from

number

after?

number

Returns

void

moveRow()

moveRow(from, after?): void

Parameters

from

number

after?

number

Returns

void

setColumnBackgroundColor()

setColumnBackgroundColor(columnId, color?): void

Parameters

columnId

string

color?

string

Returns

void

setColumnWidth()

setColumnWidth(columnId, width): void

Parameters

columnId

string

width

number

Returns

void

setRowBackgroundColor()

setRowBackgroundColor(rowId, color?): void

Parameters

rowId

string

color?

string

Returns

void

updateColumnOrder()

updateColumnOrder(columnId, newOrder): void

Parameters

columnId

string

newOrder

string

Returns

void

updateRowOrder()

updateRowOrder(rowId, newOrder): void

Parameters

rowId

string

newOrder

string

Returns

void

---

TableSelection

Extends

• BaseSelection

Constructors

Constructor

new TableSelection(__namedParameters): TableSelection

Parameters

__namedParameters

blockId

string

data

{ columnEndIndex: number; columnStartIndex: number; rowEndIndex: number; rowStartIndex: number; type: "area"; } | { rowId: string; type: "row"; } | { columnId: string; type: "column"; }

Returns

TableSelection

Overrides

BaseSelection.constructor

Properties

data

readonly data: { columnEndIndex: number; columnStartIndex: number; rowEndIndex: number; rowStartIndex: number; type: "area"; } | { rowId: string; type: "row"; } | { columnId: string; type: "column"; }

group

static group: string = 'note'

Overrides

BaseSelection.group

recoverable

static recoverable: boolean = true

Overrides

BaseSelection.recoverable

type

static type: string = 'table'

Overrides

BaseSelection.type

Accessors

Methods

equals()

equals(other): boolean

Parameters

other

BaseSelection

Returns

boolean

Overrides

BaseSelection.equals

toJSON()

toJSON(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

BaseSelection.toJSON

fromJSON()

static fromJSON(json): TableSelection

Parameters

json

Record<string, unknown>

Returns

TableSelection

Overrides

BaseSelection.fromJSON

Type Aliases

TableAreaSelection

TableAreaSelection = z.TypeOf<typeof TableAreaSelectionSchema>

---

TableSelectionData

TableSelectionData = z.TypeOf<typeof TableSelectionDataSchema>

Variables

insertTableBlockCommand

const insertTableBlockCommand: Command<{ place?: "after" | "before"; removeEmptyLine?: boolean; selectedModels?: BlockModel[]; }, { insertedTableBlockId: string; }>

---

TableBlockAdapterExtensions

const TableBlockAdapterExtensions: ExtensionType[]

---

TableBlockHtmlAdapterExtension

const TableBlockHtmlAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockHtmlAdapterMatcher>

---

tableBlockHtmlAdapterMatcher

const tableBlockHtmlAdapterMatcher: BlockHtmlAdapterMatcher

---

TableBlockMarkdownAdapterExtension

const TableBlockMarkdownAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockMarkdownAdapterMatcher>

---

tableBlockMarkdownAdapterMatcher

const tableBlockMarkdownAdapterMatcher: BlockMarkdownAdapterMatcher

---

TableBlockNotionHtmlAdapterExtension

const TableBlockNotionHtmlAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockNotionHtmlAdapterMatcher>

---

tableBlockNotionHtmlAdapterMatcher

const tableBlockNotionHtmlAdapterMatcher: BlockNotionHtmlAdapterMatcher

---

TableBlockPlainTextAdapterExtension

const TableBlockPlainTextAdapterExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<BlockPlainTextAdapterMatcher>

---

tableBlockPlainTextAdapterMatcher

const tableBlockPlainTextAdapterMatcher: BlockPlainTextAdapterMatcher

---

TableSelectionData

TableSelectionData: object

Type Declaration

equals()

equals(a?, b?): boolean

Parameters

a?

{ columnEndIndex: number; columnStartIndex: number; rowEndIndex: number; rowStartIndex: number; type: "area"; } | { rowId: string; type: "row"; } | { columnId: string; type: "column"; }

b?

{ columnEndIndex: number; columnStartIndex: number; rowEndIndex: number; rowStartIndex: number; type: "area"; } | { rowId: string; type: "row"; } | { columnId: string; type: "column"; }

Returns

boolean

---

TableSelectionExtension

const TableSelectionExtension: ExtensionType