Class: DEPRECATED_GridNode

lexical.DEPRECATED_GridNode

Hierarchy

• ElementNode

  ↳ DEPRECATED_GridNode

  ↳↳ TableNode

Constructors

constructor

• new DEPRECATED_GridNode(key?)

Parameters

Name	Type
key?	string

Inherited from

ElementNode.constructor

Defined in

lexical/src/nodes/LexicalElementNode.ts:76

Methods

append

▸ append(...nodesToAppend): DEPRECATED_GridNode

Parameters

Name	Type
...nodesToAppend	LexicalNode[]

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.append

Defined in

lexical/src/nodes/LexicalElementNode.ts:368

---

canBeEmpty

▸ canBeEmpty(): boolean

Returns

boolean

Inherited from

ElementNode.canBeEmpty

Defined in

lexical/src/nodes/LexicalElementNode.ts:560

---

canExtractContents

▸ canExtractContents(): boolean

Returns

boolean

Inherited from

ElementNode.canExtractContents

Defined in

lexical/src/nodes/LexicalElementNode.ts:551

---

canIndent

▸ canIndent(): boolean

Returns

boolean

Inherited from

ElementNode.canIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:537

---

canInsertAfter

▸ canInsertAfter(node): boolean

Parameters

Name	Type
node	LexicalNode

Returns

boolean

Inherited from

ElementNode.canInsertAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:557

---

canInsertTab

▸ canInsertTab(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTab

Defined in

lexical/src/nodes/LexicalElementNode.ts:534

---

canInsertTextAfter

▸ canInsertTextAfter(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTextAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:566

---

canInsertTextBefore

▸ canInsertTextBefore(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTextBefore

Defined in

lexical/src/nodes/LexicalElementNode.ts:563

---

canMergeWith

▸ canMergeWith(node): boolean

Parameters

Name	Type
node	ElementNode

Returns

boolean

Inherited from

ElementNode.canMergeWith

Defined in

lexical/src/nodes/LexicalElementNode.ts:579

---

canReplaceWith

▸ canReplaceWith(replacement): boolean

Parameters

Name	Type
replacement	LexicalNode

Returns

boolean

Inherited from

ElementNode.canReplaceWith

Defined in

lexical/src/nodes/LexicalElementNode.ts:554

---

clear

▸ clear(): DEPRECATED_GridNode

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.clear

Defined in

lexical/src/nodes/LexicalElementNode.ts:362

---

collapseAtStart

▸ collapseAtStart(selection): boolean

Parameters

Name	Type
selection	RangeSelection

Returns

boolean

Inherited from

ElementNode.collapseAtStart

Defined in

lexical/src/nodes/LexicalElementNode.ts:545

---

excludeFromCopy

▸ excludeFromCopy(destination?): boolean

Parameters

Name	Type
destination?	"clone" | "html"

Returns

boolean

Inherited from

ElementNode.excludeFromCopy

Defined in

lexical/src/nodes/LexicalElementNode.ts:548

---

exportJSON

▸ exportJSON(): SerializedElementNode<SerializedLexicalNode>

Returns

SerializedElementNode<SerializedLexicalNode>

Inherited from

ElementNode.exportJSON

Defined in

lexical/src/nodes/LexicalElementNode.ts:517

---

extractWithChild

▸ extractWithChild(child, selection, destination): boolean

Parameters

Name	Type
child	LexicalNode
selection	null | RangeSelection | NodeSelection | GridSelection
destination	"clone" | "html"

Returns

boolean

Inherited from

ElementNode.extractWithChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:582

---

getAllTextNodes

▸ getAllTextNodes(): TextNode[]

Returns

TextNode[]

Inherited from

ElementNode.getAllTextNodes

Defined in

lexical/src/nodes/LexicalElementNode.ts:133

---

getChildAtIndex

▸ getChildAtIndex<T>(index): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Parameters

Name	Type
index	number

Returns

null | T

Inherited from

ElementNode.getChildAtIndex

Defined in

lexical/src/nodes/LexicalElementNode.ts:220

---

getChildren

▸ getChildren<T>(): T[]

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T[]

Inherited from

ElementNode.getChildren

Defined in

lexical/src/nodes/LexicalElementNode.ts:98

---

getChildrenKeys

▸ getChildrenKeys(): string[]

Returns

string[]

Inherited from

ElementNode.getChildrenKeys

Defined in

lexical/src/nodes/LexicalElementNode.ts:107

---

getChildrenSize

▸ getChildrenSize(): number

Returns

number

Inherited from

ElementNode.getChildrenSize

Defined in

lexical/src/nodes/LexicalElementNode.ts:116

---

getDescendantByIndex

▸ getDescendantByIndex<T>(index): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Parameters

Name	Type
index	number

Returns

null | T

Inherited from

ElementNode.getDescendantByIndex

Defined in

lexical/src/nodes/LexicalElementNode.ts:176

---

getDirection

▸ getDirection(): null | "ltr" | "rtl"

Returns

null | "ltr" | "rtl"

Inherited from

ElementNode.getDirection

Defined in

lexical/src/nodes/LexicalElementNode.ts:281

---

getFirstChild

▸ getFirstChild<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getFirstChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:196

---

getFirstChildOrThrow

▸ getFirstChildOrThrow<T>(): T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T

Inherited from

ElementNode.getFirstChildOrThrow

Defined in

lexical/src/nodes/LexicalElementNode.ts:201

---

getFirstDescendant

▸ getFirstDescendant<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getFirstDescendant

Defined in

lexical/src/nodes/LexicalElementNode.ts:148

---

getFormat

▸ getFormat(): number

Returns

number

Inherited from

ElementNode.getFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:86

---

getFormatType

▸ getFormatType(): ElementFormatType

Returns

ElementFormatType

Inherited from

ElementNode.getFormatType

Defined in

lexical/src/nodes/LexicalElementNode.ts:90

---

getIndent

▸ getIndent(): number

Returns

number

Inherited from

ElementNode.getIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:94

---

getLastChild

▸ getLastChild<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getLastChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:208

---

getLastChildOrThrow

▸ getLastChildOrThrow<T>(): T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T

Inherited from

ElementNode.getLastChildOrThrow

Defined in

lexical/src/nodes/LexicalElementNode.ts:213

---

getLastDescendant

▸ getLastDescendant<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getLastDescendant

Defined in

lexical/src/nodes/LexicalElementNode.ts:162

---

getTextContent

▸ getTextContent(): string

Returns

string

Inherited from

ElementNode.getTextContent

Defined in

lexical/src/nodes/LexicalElementNode.ts:247

---

getTextContentSize

▸ getTextContentSize(): number

Returns

number

Inherited from

ElementNode.getTextContentSize

Defined in

lexical/src/nodes/LexicalElementNode.ts:264

---

hasFormat

▸ hasFormat(type): boolean

Parameters

Name	Type
type	ElementFormatType

Returns

boolean

Inherited from

ElementNode.hasFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:285

---

insertNewAfter

▸ insertNewAfter(selection, restoreSelection?): null | LexicalNode

Parameters

Name	Type
selection	RangeSelection
restoreSelection?	boolean

Returns

null | LexicalNode

Inherited from

ElementNode.insertNewAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:528

---

isDirty

▸ isDirty(): boolean

Returns

boolean

Inherited from

ElementNode.isDirty

Defined in

lexical/src/nodes/LexicalElementNode.ts:123

---

isEmpty

▸ isEmpty(): boolean

Returns

boolean

Inherited from

ElementNode.isEmpty

Defined in

lexical/src/nodes/LexicalElementNode.ts:120

---

isInline

▸ isInline(): boolean

Returns

boolean

Inherited from

ElementNode.isInline

Defined in

lexical/src/nodes/LexicalElementNode.ts:569

---

isLastChild

▸ isLastChild(): boolean

Returns

boolean

Inherited from

ElementNode.isLastChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:128

---

isShadowRoot

▸ isShadowRoot(): boolean

Returns

boolean

Inherited from

ElementNode.isShadowRoot

Defined in

lexical/src/nodes/LexicalElementNode.ts:576

---

select

▸ select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

Name	Type
_anchorOffset?	number
_focusOffset?	number

Returns

RangeSelection

Inherited from

ElementNode.select

Defined in

lexical/src/nodes/LexicalElementNode.ts:295

---

selectEnd

▸ selectEnd(): RangeSelection

Returns

RangeSelection

Inherited from

ElementNode.selectEnd

Defined in

lexical/src/nodes/LexicalElementNode.ts:351

---

selectStart

▸ selectStart(): RangeSelection

Returns

RangeSelection

Inherited from

ElementNode.selectStart

Defined in

lexical/src/nodes/LexicalElementNode.ts:340

---

setDirection

▸ setDirection(direction): DEPRECATED_GridNode

Parameters

Name	Type
direction	null | "ltr" | "rtl"

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.setDirection

Defined in

lexical/src/nodes/LexicalElementNode.ts:371

---

setFormat

▸ setFormat(type): DEPRECATED_GridNode

Parameters

Name	Type
type	ElementFormatType

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.setFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:376

---

setIndent

▸ setIndent(indentLevel): DEPRECATED_GridNode

Parameters

Name	Type
indentLevel	number

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.setIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:381

---

splice

▸ splice(start, deleteCount, nodesToInsert): DEPRECATED_GridNode

Parameters

Name	Type
start	number
deleteCount	number
nodesToInsert	LexicalNode[]

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.splice

Defined in

lexical/src/nodes/LexicalElementNode.ts:386