Skip to main content

Class: DEPRECATED_GridNode

lexical.DEPRECATED_GridNode

Hierarchy

Constructors

constructor

new DEPRECATED_GridNode(key?)

Parameters

NameType
key?string

Inherited from

ElementNode.constructor

Defined in

lexical/src/nodes/LexicalElementNode.ts:74

Methods

append

append(...nodesToAppend): DEPRECATED_GridNode

Parameters

NameType
...nodesToAppendLexicalNode[]

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.append

Defined in

lexical/src/nodes/LexicalElementNode.ts:349


canBeEmpty

canBeEmpty(): boolean

Returns

boolean

Inherited from

ElementNode.canBeEmpty

Defined in

lexical/src/nodes/LexicalElementNode.ts:541


canExtractContents

canExtractContents(): boolean

Returns

boolean

Inherited from

ElementNode.canExtractContents

Defined in

lexical/src/nodes/LexicalElementNode.ts:532


canIndent

canIndent(): boolean

Returns

boolean

Inherited from

ElementNode.canIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:518


canInsertAfter

canInsertAfter(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Inherited from

ElementNode.canInsertAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:538


canInsertTab

canInsertTab(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTab

Defined in

lexical/src/nodes/LexicalElementNode.ts:515


canInsertTextAfter

canInsertTextAfter(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTextAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:547


canInsertTextBefore

canInsertTextBefore(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTextBefore

Defined in

lexical/src/nodes/LexicalElementNode.ts:544


canMergeWith

canMergeWith(node): boolean

Parameters

NameType
nodeElementNode

Returns

boolean

Inherited from

ElementNode.canMergeWith

Defined in

lexical/src/nodes/LexicalElementNode.ts:560


canReplaceWith

canReplaceWith(replacement): boolean

Parameters

NameType
replacementLexicalNode

Returns

boolean

Inherited from

ElementNode.canReplaceWith

Defined in

lexical/src/nodes/LexicalElementNode.ts:535


clear

clear(): DEPRECATED_GridNode

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.clear

Defined in

lexical/src/nodes/LexicalElementNode.ts:343


collapseAtStart

collapseAtStart(selection): boolean

Parameters

NameType
selectionRangeSelection

Returns

boolean

Inherited from

ElementNode.collapseAtStart

Defined in

lexical/src/nodes/LexicalElementNode.ts:526


excludeFromCopy

excludeFromCopy(destination?): boolean

Parameters

NameType
destination?"clone" | "html"

Returns

boolean

Inherited from

ElementNode.excludeFromCopy

Defined in

lexical/src/nodes/LexicalElementNode.ts:529


exportJSON

exportJSON(): SerializedElementNode

Returns

SerializedElementNode

Inherited from

ElementNode.exportJSON

Defined in

lexical/src/nodes/LexicalElementNode.ts:498


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionnull | RangeSelection | NodeSelection | GridSelection
destination"clone" | "html"

Returns

boolean

Inherited from

ElementNode.extractWithChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:563


getAllTextNodes

getAllTextNodes(): TextNode[]

Returns

TextNode[]

Inherited from

ElementNode.getAllTextNodes

Defined in

lexical/src/nodes/LexicalElementNode.ts:131


getChildAtIndex

getChildAtIndex<T>(index): null | T

Type parameters

NameType
Textends LexicalNode<T>

Parameters

NameType
indexnumber

Returns

null | T

Inherited from

ElementNode.getChildAtIndex

Defined in

lexical/src/nodes/LexicalElementNode.ts:218


getChildren

getChildren<T>(): T[]

Type parameters

NameType
Textends LexicalNode<T>

Returns

T[]

Inherited from

ElementNode.getChildren

Defined in

lexical/src/nodes/LexicalElementNode.ts:96


getChildrenKeys

getChildrenKeys(): string[]

Returns

string[]

Inherited from

ElementNode.getChildrenKeys

Defined in

lexical/src/nodes/LexicalElementNode.ts:105


getChildrenSize

getChildrenSize(): number

Returns

number

Inherited from

ElementNode.getChildrenSize

Defined in

lexical/src/nodes/LexicalElementNode.ts:114


getDescendantByIndex

getDescendantByIndex<T>(index): null | T

Type parameters

NameType
Textends LexicalNode<T>

Parameters

NameType
indexnumber

Returns

null | T

Inherited from

ElementNode.getDescendantByIndex

Defined in

lexical/src/nodes/LexicalElementNode.ts:174


getDirection

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

Returns

null | "ltr" | "rtl"

Inherited from

ElementNode.getDirection

Defined in

lexical/src/nodes/LexicalElementNode.ts:262


getFirstChild

getFirstChild<T>(): null | T

Type parameters

NameType
Textends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getFirstChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:194


getFirstChildOrThrow

getFirstChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode<T>

Returns

T

Inherited from

ElementNode.getFirstChildOrThrow

Defined in

lexical/src/nodes/LexicalElementNode.ts:199


getFirstDescendant

getFirstDescendant<T>(): null | T

Type parameters

NameType
Textends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getFirstDescendant

Defined in

lexical/src/nodes/LexicalElementNode.ts:146


getFormat

getFormat(): number

Returns

number

Inherited from

ElementNode.getFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:84


getFormatType

getFormatType(): ElementFormatType

Returns

ElementFormatType

Inherited from

ElementNode.getFormatType

Defined in

lexical/src/nodes/LexicalElementNode.ts:88


getIndent

getIndent(): number

Returns

number

Inherited from

ElementNode.getIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:92


getLastChild

getLastChild<T>(): null | T

Type parameters

NameType
Textends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getLastChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:206


getLastChildOrThrow

getLastChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode<T>

Returns

T

Inherited from

ElementNode.getLastChildOrThrow

Defined in

lexical/src/nodes/LexicalElementNode.ts:211


getLastDescendant

getLastDescendant<T>(): null | T

Type parameters

NameType
Textends LexicalNode<T>

Returns

null | T

Inherited from

ElementNode.getLastDescendant

Defined in

lexical/src/nodes/LexicalElementNode.ts:160


getTextContent

getTextContent(): string

Returns

string

Inherited from

ElementNode.getTextContent

Defined in

lexical/src/nodes/LexicalElementNode.ts:245


hasFormat

hasFormat(type): boolean

Parameters

NameType
typeElementFormatType

Returns

boolean

Inherited from

ElementNode.hasFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:266


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | LexicalNode

Parameters

NameType
selectionRangeSelection
restoreSelection?boolean

Returns

null | LexicalNode

Inherited from

ElementNode.insertNewAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:509


isDirty

isDirty(): boolean

Returns

boolean

Inherited from

ElementNode.isDirty

Defined in

lexical/src/nodes/LexicalElementNode.ts:121


isEmpty

isEmpty(): boolean

Returns

boolean

Inherited from

ElementNode.isEmpty

Defined in

lexical/src/nodes/LexicalElementNode.ts:118


isInline

isInline(): boolean

Returns

boolean

Inherited from

ElementNode.isInline

Defined in

lexical/src/nodes/LexicalElementNode.ts:550


isLastChild

isLastChild(): boolean

Returns

boolean

Inherited from

ElementNode.isLastChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:126


isShadowRoot

isShadowRoot(): boolean

Returns

boolean

Inherited from

ElementNode.isShadowRoot

Defined in

lexical/src/nodes/LexicalElementNode.ts:557


select

select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

NameType
_anchorOffset?number
_focusOffset?number

Returns

RangeSelection

Inherited from

ElementNode.select

Defined in

lexical/src/nodes/LexicalElementNode.ts:276


selectEnd

selectEnd(): RangeSelection

Returns

RangeSelection

Inherited from

ElementNode.selectEnd

Defined in

lexical/src/nodes/LexicalElementNode.ts:332


selectStart

selectStart(): RangeSelection

Returns

RangeSelection

Inherited from

ElementNode.selectStart

Defined in

lexical/src/nodes/LexicalElementNode.ts:321


setDirection

setDirection(direction): DEPRECATED_GridNode

Parameters

NameType
directionnull | "ltr" | "rtl"

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.setDirection

Defined in

lexical/src/nodes/LexicalElementNode.ts:352


setFormat

setFormat(type): DEPRECATED_GridNode

Parameters

NameType
typeElementFormatType

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.setFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:357


setIndent

setIndent(indentLevel): DEPRECATED_GridNode

Parameters

NameType
indentLevelnumber

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.setIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:362


splice

splice(start, deleteCount, nodesToInsert): DEPRECATED_GridNode

Parameters

NameType
startnumber
deleteCountnumber
nodesToInsertLexicalNode[]

Returns

DEPRECATED_GridNode

Inherited from

ElementNode.splice

Defined in

lexical/src/nodes/LexicalElementNode.ts:367