Skip to main content

Class: GridNode

lexical.GridNode

Hierarchy

Constructors

constructor

new GridNode(key?)

Parameters

NameType
key?string

Inherited from

ElementNode.constructor

Defined in

lexical/src/nodes/LexicalElementNode.ts:63

Methods

append

append(...nodesToAppend): GridNode

Parameters

NameType
...nodesToAppendLexicalNode[]

Returns

GridNode

Inherited from

ElementNode.append

Defined in

lexical/src/nodes/LexicalElementNode.ts:301


canBeEmpty

canBeEmpty(): boolean

Returns

boolean

Inherited from

ElementNode.canBeEmpty

Defined in

lexical/src/nodes/LexicalElementNode.ts:477


canExtractContents

canExtractContents(): boolean

Returns

boolean

Inherited from

ElementNode.canExtractContents

Defined in

lexical/src/nodes/LexicalElementNode.ts:468


canIndent

canIndent(): boolean

Returns

boolean

Inherited from

ElementNode.canIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:459


canInsertAfter

canInsertAfter(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Inherited from

ElementNode.canInsertAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:474


canInsertTab

canInsertTab(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTab

Defined in

lexical/src/nodes/LexicalElementNode.ts:456


canInsertTextAfter

canInsertTextAfter(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTextAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:483


canInsertTextBefore

canInsertTextBefore(): boolean

Returns

boolean

Inherited from

ElementNode.canInsertTextBefore

Defined in

lexical/src/nodes/LexicalElementNode.ts:480


canMergeWith

canMergeWith(node): boolean

Parameters

NameType
nodeElementNode

Returns

boolean

Inherited from

ElementNode.canMergeWith

Defined in

lexical/src/nodes/LexicalElementNode.ts:489


canReplaceWith

canReplaceWith(replacement): boolean

Parameters

NameType
replacementLexicalNode

Returns

boolean

Inherited from

ElementNode.canReplaceWith

Defined in

lexical/src/nodes/LexicalElementNode.ts:471


clear

clear(): GridNode

Returns

GridNode

Inherited from

ElementNode.clear

Defined in

lexical/src/nodes/LexicalElementNode.ts:294


collapseAtStart

collapseAtStart(selection): boolean

Parameters

NameType
selectionRangeSelection

Returns

boolean

Inherited from

ElementNode.collapseAtStart

Defined in

lexical/src/nodes/LexicalElementNode.ts:462


excludeFromCopy

excludeFromCopy(destination?): boolean

Parameters

NameType
destination?"html" | "clone"

Returns

boolean

Inherited from

ElementNode.excludeFromCopy

Defined in

lexical/src/nodes/LexicalElementNode.ts:465


exportJSON

exportJSON(): SerializedElementNode

Returns

SerializedElementNode

Inherited from

ElementNode.exportJSON

Defined in

lexical/src/nodes/LexicalElementNode.ts:442


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

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

Returns

boolean

Inherited from

ElementNode.extractWithChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:492


getAllTextNodes

getAllTextNodes(includeInert?): TextNode[]

Parameters

NameType
includeInert?boolean

Returns

TextNode[]

Inherited from

ElementNode.getAllTextNodes

Defined in

lexical/src/nodes/LexicalElementNode.ts:115


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:203


getChildren

getChildren<T>(): T[]

Type parameters

NameType
Textends LexicalNode<T>

Returns

T[]

Inherited from

ElementNode.getChildren

Defined in

lexical/src/nodes/LexicalElementNode.ts:83


getChildrenKeys

getChildrenKeys(): string[]

Returns

string[]

Inherited from

ElementNode.getChildrenKeys

Defined in

lexical/src/nodes/LexicalElementNode.ts:95


getChildrenSize

getChildrenSize(): number

Returns

number

Inherited from

ElementNode.getChildrenSize

Defined in

lexical/src/nodes/LexicalElementNode.ts:98


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:158


getDirection

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

Returns

null | "ltr" | "rtl"

Inherited from

ElementNode.getDirection

Defined in

lexical/src/nodes/LexicalElementNode.ts:229


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:178


getFirstChildOrThrow

getFirstChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode<T>

Returns

T

Inherited from

ElementNode.getFirstChildOrThrow

Defined in

lexical/src/nodes/LexicalElementNode.ts:187


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:130


getFormat

getFormat(): number

Returns

number

Inherited from

ElementNode.getFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:71


getFormatType

getFormatType(): ElementFormatType

Returns

ElementFormatType

Inherited from

ElementNode.getFormatType

Defined in

lexical/src/nodes/LexicalElementNode.ts:75


getIndent

getIndent(): number

Returns

number

Inherited from

ElementNode.getIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:79


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:194


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:144


getTextContent

getTextContent(includeInert?, includeDirectionless?): string

Parameters

NameType
includeInert?boolean
includeDirectionless?false

Returns

string

Inherited from

ElementNode.getTextContent

Defined in

lexical/src/nodes/LexicalElementNode.ts:212


hasFormat

hasFormat(type): boolean

Parameters

NameType
typeElementFormatType

Returns

boolean

Inherited from

ElementNode.hasFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:233


insertNewAfter

insertNewAfter(selection): null | LexicalNode

Parameters

NameType
selectionRangeSelection

Returns

null | LexicalNode

Inherited from

ElementNode.insertNewAfter

Defined in

lexical/src/nodes/LexicalElementNode.ts:453


isDirty

isDirty(): boolean

Returns

boolean

Inherited from

ElementNode.isDirty

Defined in

lexical/src/nodes/LexicalElementNode.ts:105


isEmpty

isEmpty(): boolean

Returns

boolean

Inherited from

ElementNode.isEmpty

Defined in

lexical/src/nodes/LexicalElementNode.ts:102


isInline

isInline(): boolean

Returns

boolean

Inherited from

ElementNode.isInline

Defined in

lexical/src/nodes/LexicalElementNode.ts:486


isLastChild

isLastChild(): boolean

Returns

boolean

Inherited from

ElementNode.isLastChild

Defined in

lexical/src/nodes/LexicalElementNode.ts:110


select

select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

NameType
_anchorOffset?number
_focusOffset?number

Returns

RangeSelection

Inherited from

ElementNode.select

Defined in

lexical/src/nodes/LexicalElementNode.ts:243


selectEnd

selectEnd(): RangeSelection

Returns

RangeSelection

Inherited from

ElementNode.selectEnd

Defined in

lexical/src/nodes/LexicalElementNode.ts:283


selectStart

selectStart(): RangeSelection

Returns

RangeSelection

Inherited from

ElementNode.selectStart

Defined in

lexical/src/nodes/LexicalElementNode.ts:272


setDirection

setDirection(direction): GridNode

Parameters

NameType
directionnull | "ltr" | "rtl"

Returns

GridNode

Inherited from

ElementNode.setDirection

Defined in

lexical/src/nodes/LexicalElementNode.ts:305


setFormat

setFormat(type): GridNode

Parameters

NameType
typeElementFormatType

Returns

GridNode

Inherited from

ElementNode.setFormat

Defined in

lexical/src/nodes/LexicalElementNode.ts:311


setIndent

setIndent(indentLevel): GridNode

Parameters

NameType
indentLevelnumber

Returns

GridNode

Inherited from

ElementNode.setIndent

Defined in

lexical/src/nodes/LexicalElementNode.ts:317


splice

splice(start, deleteCount, nodesToInsert): GridNode

Parameters

NameType
startnumber
deleteCountnumber
nodesToInsertLexicalNode[]

Returns

GridNode

Inherited from

ElementNode.splice

Defined in

lexical/src/nodes/LexicalElementNode.ts:323