模組: @lexical/table
類別
類型別名
HTMLTableElementWithWithTableSelectionState
Ƭ HTMLTableElementWithWithTableSelectionState: HTMLTableElement & Record<typeof LEXICAL_ELEMENT_KEY, TableObserver>
定義於
packages/lexical-table/src/LexicalTableSelectionHelpers.ts:897
InsertTableCommandPayload
Ƭ InsertTableCommandPayload: Readonly<{ columns: string ; includeHeaders?: InsertTableCommandPayloadHeaders ; rows: string }>
定義於
packages/lexical-table/src/LexicalTableCommands.ts:20
InsertTableCommandPayloadHeaders
Ƭ InsertTableCommandPayloadHeaders: Readonly<{ columns: boolean ; rows: boolean }> | boolean
定義於
packages/lexical-table/src/LexicalTableCommands.ts:13
SerializedTableCellNode
Ƭ SerializedTableCellNode: Spread<{ backgroundColor?: null | string ; colSpan?: number ; headerState: TableCellHeaderState ; rowSpan?: number ; width?: number }, SerializedElementNode>
定義於
packages/lexical-table/src/LexicalTableCellNode.ts:43
SerializedTableNode
Ƭ SerializedTableNode: SerializedElementNode
定義於
packages/lexical-table/src/LexicalTableNode.ts:33
SerializedTableRowNode
Ƭ SerializedTableRowNode: Spread<{ height?: number }, SerializedElementNode>
定義於
packages/lexical-table/src/LexicalTableRowNode.ts:25
TableDOMCell
Ƭ TableDOMCell: Object
類型聲明
| 名稱 | 類型 |
|---|---|
elem | HTMLElement |
hasBackgroundColor | boolean |
highlighted | boolean |
x | number |
y | number |
定義於
packages/lexical-table/src/LexicalTableObserver.ts:43
TableMapType
Ƭ TableMapType: TableMapValueType[][]
定義於
packages/lexical-table/src/LexicalTableSelection.ts:40
TableMapValueType
Ƭ TableMapValueType: Object
類型聲明
| 名稱 | 類型 |
|---|---|
cell | TableCellNode |
startColumn | number |
startRow | number |
定義於
packages/lexical-table/src/LexicalTableSelection.ts:35
TableSelectionShape
Ƭ TableSelectionShape: Object
類型聲明
| 名稱 | 類型 |
|---|---|
fromX | number |
fromY | number |
toX | number |
toY | number |
定義於
packages/lexical-table/src/LexicalTableSelection.ts:28
變數
INSERT_TABLE_COMMAND
• Const INSERT_TABLE_COMMAND: LexicalCommand<InsertTableCommandPayload>
定義於
packages/lexical-table/src/LexicalTableCommands.ts:26
TableCellHeaderStates
• Const TableCellHeaderStates: Object
類型聲明
| 名稱 | 類型 |
|---|---|
BOTH | number |
COLUMN | number |
NO_STATUS | number |
ROW | number |
定義於
packages/lexical-table/src/LexicalTableCellNode.ts:33
函數
$computeTableMap
▸ $computeTableMap(grid, cellA, cellB): [TableMapType, TableMapValueType, TableMapValueType]
參數
| 名稱 | 類型 |
|---|---|
grid | TableNode |
cellA | TableCellNode |
cellB | TableCellNode |
返回
[TableMapType, TableMapValueType, TableMapValueType]
定義於
packages/lexical-table/src/LexicalTableUtils.ts:724
$computeTableMapSkipCellCheck
▸ $computeTableMapSkipCellCheck(grid, cellA, cellB): [TableMapType, TableMapValueType | null, TableMapValueType | null]
參數
| 名稱 | 類型 |
|---|---|
grid | TableNode |
cellA | null | TableCellNode |
cellB | null | TableCellNode |
返回
[TableMapType, TableMapValueType | null, TableMapValueType | null]
定義於
packages/lexical-table/src/LexicalTableUtils.ts:739
$createTableCellNode
▸ $createTableCellNode(`
headerState, colSpan?, width?): [TableCellNode`](../classes/lexical_table.TableCellNode.md)
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
headerState | number | undefined |
colSpan | number | 1 |
width? | number | undefined |
返回
定義於
packages/lexical-table/src/LexicalTableCellNode.ts:362
$createTableNode
▸ $createTableNode(): TableNode
返回
定義於
packages/lexical-table/src/LexicalTableNode.ts:248
$createTableNodeWithDimensions
▸ $createTableNodeWithDimensions(rowCount, columnCount, includeHeaders?): TableNode
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
rowCount | number | undefined |
columnCount | number | undefined |
includeHeaders | InsertTableCommandPayloadHeaders | true |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:39
$createTableRowNode
▸ $createTableRowNode(height?): TableRowNode
參數
| 名稱 | 類型 |
|---|---|
height? | number |
返回
定義於
packages/lexical-table/src/LexicalTableRowNode.ts:122
$createTableSelection
▸ $createTableSelection(): TableSelection
返回
定義於
packages/lexical-table/src/LexicalTableSelection.ts:347
$deleteTableColumn
▸ $deleteTableColumn(tableNode, targetIndex): TableNode
參數
| 名稱 | 類型 |
|---|---|
tableNode | TableNode |
targetIndex | number |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:476
$deleteTableColumn__EXPERIMENTAL
▸ $deleteTableColumn__EXPERIMENTAL(): void
返回
void
定義於
packages/lexical-table/src/LexicalTableUtils.ts:575
$deleteTableRow__EXPERIMENTAL
▸ $deleteTableRow__EXPERIMENTAL(): void
返回
void
定義於
packages/lexical-table/src/LexicalTableUtils.ts:499
$findCellNode
▸ $findCellNode(node): null | TableCellNode
參數
| 名稱 | 類型 |
|---|---|
node | LexicalNode |
返回
null | TableCellNode
定義於
packages/lexical-table/src/LexicalTableSelectionHelpers.ts:1284
$findTableNode
▸ $findTableNode(node): null | TableNode
參數
| 名稱 | 類型 |
|---|---|
node | LexicalNode |
返 回
null | TableNode
定義於
packages/lexical-table/src/LexicalTableSelectionHelpers.ts:1289
$getElementForTableNode
▸ $getElementForTableNode(editor, tableNode): TableDOMTable
參數
| 名稱 | 類型 |
|---|---|
editor | LexicalEditor |
tableNode | TableNode |
返回
TableDOMTable
定義於
packages/lexical-table/src/LexicalTableNode.ts:231
$getNodeTriplet
▸ $getNodeTriplet(source): [TableCellNode, TableRowNode, TableNode]
參數
| 名稱 | 類型 |
|---|---|
source | LexicalNode | PointType | TableCellNode |
返回
[TableCellNode, TableRowNode, TableNode]
定義於
packages/lexical-table/src/LexicalTableUtils.ts:798
$getTableCellNodeFromLexicalNode
▸ $getTableCellNodeFromLexicalNode(startingNode): TableCellNode | null
參數
| 名稱 | 類型 |
|---|---|
startingNode | LexicalNode |
返回
TableCellNode | null
定義於
packages/lexical-table/src/LexicalTableUtils.ts:81
$getTableCellNodeRect
▸ $getTableCellNodeRect(tableCellNode): { colSpan: number ; columnIndex: number ; rowIndex: number ; rowSpan: number } | null
參數
| 名稱 | 類型 |
|---|---|
tableCellNode | TableCellNode |
返回
{ colSpan: number ; columnIndex: number ; rowIndex: number ; rowSpan: number } | null
定義於
packages/lexical-table/src/LexicalTableUtils.ts:832
$getTableColumnIndexFromTableCellNode
▸ $getTableColumnIndexFromTableCellNode(tableCellNode): number
參數
| 名稱 | 類型 |
|---|---|
tableCellNode | TableCellNode |
返回
number
定義於
packages/lexical-table/src/LexicalTableUtils.ts:125
$getTableNodeFromLexicalNodeOrThrow
▸ $getTableNodeFromLexicalNodeOrThrow(startingNode): TableNode
參數
| 名稱 | 類型 | | :
------------- | :------------------------------------------------- |
| startingNode | LexicalNode |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:105
$getTableRowIndexFromTableCellNode
▸ $getTableRowIndexFromTableCellNode(tableCellNode): number
參數
| 名稱 | 類型 |
|---|---|
tableCellNode | TableCellNode |
返回
number
定義於
packages/lexical-table/src/LexicalTableUtils.ts:117
$getTableRowNodeFromTableCellNodeOrThrow
▸ $getTableRowNodeFromTableCellNodeOrThrow(startingNode): TableRowNode
參數
| 名稱 | 類型 |
|---|---|
startingNode | LexicalNode |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:93
$insertTableColumn
▸ $insertTableColumn(tableNode, targetIndex, shouldInsertAfter?, columnCount, table): TableNode
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
tableNode | TableNode | undefined |
targetIndex | number | undefined |
shouldInsertAfter | boolean | true |
columnCount | number | undefined |
table | TableDOMTable | undefined |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:317
$insertTableColumn__EXPERIMENTAL
▸ $insertTableColumn__EXPERIMENTAL(insertAfter?): void
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
insertAfter | boolean | true |
返回
void
定義於
packages/lexical-table/src/LexicalTableUtils.ts:376
$insertTableRow
▸ $insertTableRow(tableNode, targetIndex, shouldInsertAfter?, rowCount, table): TableNode
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
tableNode | TableNode | undefined |
targetIndex | number | undefined |
shouldInsertAfter | boolean | true |
rowCount | number | undefined |
table | TableDOMTable | undefined |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:168
$insertTableRow__EXPERIMENTAL
▸ $insertTableRow__EXPERIMENTAL(insertAfter?): void
參數
| 名稱 | 類型 | 預設值 |
|---|---|---|
insertAfter | boolean | true |
返回
void
定義於
packages/lexical-table/src/LexicalTableUtils.ts:248
$isTableCellNode
▸ $isTableCellNode(node): node is TableCellNode
參數
| 名稱 | 類型 |
|---|---|
node | undefined | null | LexicalNode |
返回
node is TableCellNode
定義於
packages/lexical-table/src/LexicalTableCellNode.ts:370
$isTableNode
▸ $isTableNode(node): node is TableNode
參數
| 名稱 | 類型 |
|---|---|
node | undefined | null | LexicalNode |
返回
node is TableNode
定義於
packages/lexical-table/src/LexicalTableNode.ts:252
$isTableRowNode
▸ $isTableRowNode(node): node is TableRowNode
參數
| 名稱 | 類型 |
|---|---|
node | undefined | null | LexicalNode |
返回
node is TableRowNode
定義於
packages/lexical-table/src/LexicalTableRowNode.ts:126
$isTableSelection
▸ $isTableSelection(x): x is TableSelection
參數
| 名稱 | 類型 |
|---|---|
x | unknown |
返回
x is TableSelection
定義於
packages/lexical-table/src/LexicalTableSelection.ts:343
$removeTableRowAtIndex
▸ $removeTableRowAtIndex(tableNode, indexToDelete): TableNode
參數
| 名稱 | 類型 |
|---|---|
tableNode | TableNode |
indexToDelete | number |
返回
定義於
packages/lexical-table/src/LexicalTableUtils.ts:153
$unmergeCell
▸ $unmergeCell(): void
返回
void
定義於
packages/lexical-table/src/LexicalTableUtils.ts:666
applyTableHandlers
▸ applyTableHandlers(tableNode, tableElement, editor, hasTabHandler): TableObserver
參數
| 名稱 | 類型 |
|---|---|
tableNode | TableNode |
tableElement | HTMLTableElementWithWithTableSelectionState |
editor | LexicalEditor |
hasTabHandler | boolean |
返回
定義於
packages/lexical-table/src/LexicalTableSelectionHelpers.ts:86
getDOMCellFromTarget
▸ **
getDOMCellFromTarget**(node): TableDOMCell | null
參數
| 名稱 | 類型 |
|---|---|
node | Node |
返回
TableDOMCell | null
定義於
packages/lexical-table/src/LexicalTableSelectionHelpers.ts:913
getTableObserverFromTableElement
▸ getTableObserverFromTableElement(tableElement): TableObserver | null
參數
| 名稱 | 類型 |
|---|---|
tableElement | HTMLTableElementWithWithTableSelectionState |
返回
TableObserver | null
定義於
packages/lexical-table/src/LexicalTableSelectionHelpers.ts:907