跳至主要内容

Class: TableCellNode

@lexical/table.TableCellNode

繼承結構

ElementNode

TableCellNode

構造函式

constructor

new TableCellNode(headerState?, colSpan?, width?, key?): TableCellNode

參數

名稱類型預設值
headerStatenumberTableCellHeaderStates.NO_STATUS
colSpannumber1
width?numberundefined
key?stringundefined

返回

TableCellNode

重寫自

ElementNode.constructor

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:109

函式

canBeEmpty

canBeEmpty(): false

返回

false

重寫自

ElementNode.canBeEmpty

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:280


canIndent

canIndent(): false

返回

false

重寫自

ElementNode.canIndent

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:284


collapseAtStart

collapseAtStart(): true

返回

true

重寫自

ElementNode.collapseAtStart

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:276


createDOM

createDOM(config): HTMLElement

在調和過程中調用以確定應插入到 DOM 中的節點。

此函式必須返回一個 HTMLElement。不支援嵌套元素。

在此更新生命週期階段,請不要嘗試更新 Lexical EditorState。

參數

名稱類型描述
configEditorConfig允許在調和過程中訪問如 EditorTheme(應用類別)等內容。

返回

HTMLElement

重寫自

ElementNode.createDOM

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:123


exportDOM

exportDOM(editor): DOMExportOutput

控制此節點如何序列化為 HTML。這對於 Lexical 與非 Lexical 編輯器之間的複製和粘貼,或具有不同命名空間的 Lexical 編輯器非常重要,因為主要的轉換格式是 HTML。如果你正在通過 $generateHtmlFromNodes 將其序列化為 HTML,也很重要。你還可以使用此函式構建自己的 HTML 渲染器。

參數

名稱類型
editorLexicalEditor

返回

DOMExportOutput

重寫自

ElementNode.exportDOM

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:150


exportJSON

exportJSON(): SerializedTableCellNode

控制此節點如何序列化為 JSON。這對於在共享相同命名空間的 Lexical 編輯器之間進行複製和粘貼非常重要。如果你正在將其序列化為 JSON 以便於某處持久儲存,也很重要。 參見 Serialization & Deserialization

返回

SerializedTableCellNode

重寫自

ElementNode.exportJSON

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:180


getBackgroundColor

getBackgroundColor(): null | string

返回

null | string

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:234


getColSpan

getColSpan(): number

返回

number

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:192


getHeaderStyles

getHeaderStyles(): number

返回

number

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:220


getRowSpan

getRowSpan(): number

返回

number

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:201


getTag

getTag(): string

返回

string

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:210

getWidth

getWidth(): undefined | number

返回

undefined | number

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:230


hasHeader

hasHeader(): boolean

返回

boolean

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:258


hasHeaderState

hasHeaderState(headerState): boolean

參數

名稱類型
headerStatenumber

返回

boolean

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:254


isShadowRoot

isShadowRoot(): boolean

返回

boolean

重寫自

ElementNode.isShadowRoot

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:272


setBackgroundColor

setBackgroundColor(newBackgroundColor): void

參數

名稱類型
newBackgroundColornull | string

返回

void

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:238


setColSpan

setColSpan(colSpan): this

參數

名稱類型
colSpannumber

返回

this

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:196


setHeaderStyles

setHeaderStyles(headerState): number

參數

名稱類型
headerStatenumber

返回

number

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:214


setRowSpan

setRowSpan(rowSpan): this

參數

名稱類型
rowSpannumber

返回

this

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:205


setWidth

setWidth(width): undefined | null | number

參數

名稱類型
widthnumber

返回

undefined | null | number

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:224


toggleHeaderStyle

toggleHeaderStyle(headerStateToToggle): TableCellNode

參數

名稱類型
headerStateToTogglenumber

返回

TableCellNode

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:242


updateDOM

updateDOM(prevNode): boolean

當節點變更且應該更新 DOM 以使其與可能在更新過程中發生的任何變更對齊時調用。

返回 "true" 將導致 lexical 卸載並重新創建 DOM 節點(通過調用 createDOM)。例如,當元素標籤變更時,你需要這麼做。

參數

名稱類型
prevNodeTableCellNode

返回

boolean

重寫自

ElementNode.updateDOM

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:262


clone

clone(node): TableCellNode

克隆此節點,創建一個具有不同鍵的新節點,並將其添加到 EditorState(但不附加到任何地方!)。所有節點必須實現此函式。

參數

名稱類型
nodeTableCellNode

返回

TableCellNode

重寫自

ElementNode.clone

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:71


getType

getType(): string

返回此節點的字串類型。每個節點必須實現此函式,並且在編輯器中註冊的節點之間必須唯一。

返回

string

重寫自

ElementNode.getType

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:67


importDOM

importDOM(): null | DOMConversionMap

返回

null | DOMConversionMap

重寫自

ElementNode.importDOM

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:83


importJSON

importJSON(serializedNode): TableCellNode

控制如何從 JSON 反序列化此節點。這通常是模板代碼,但提供了節點實現與序列化介面之間的抽象,如果你對節點模式進行重大更改(通過添加或刪除屬性),這可能會很重要。 參見 Serialization & Deserialization

參數

名稱類型
serializedNodeSerializedTableCellNode

返回

TableCellNode

重寫自

ElementNode.importJSON

定義於

packages/lexical-table/src/LexicalTableCellNode.ts:96