Skip to main content

Class: GridSelection

@lexical/table.GridSelection

Implements

Constructors

constructor

new GridSelection(gridKey, anchor, focus)

Parameters

NameType
gridKeystring
anchorPointType
focusPointType

Defined in

lexical-table/src/LexicalGridSelection.ts:43

Properties

_cachedNodes

_cachedNodes: null | LexicalNode[]

Implementation of

BaseSelection._cachedNodes

Defined in

lexical-table/src/LexicalGridSelection.ts:40


anchor

anchor: PointType

Defined in

lexical-table/src/LexicalGridSelection.ts:38


dirty

dirty: boolean

Implementation of

BaseSelection.dirty

Defined in

lexical-table/src/LexicalGridSelection.ts:41


focus

focus: PointType

Defined in

lexical-table/src/LexicalGridSelection.ts:39


gridKey

gridKey: string

Defined in

lexical-table/src/LexicalGridSelection.ts:37

Methods

clone

clone(): GridSelection

Returns

GridSelection

Implementation of

BaseSelection.clone

Defined in

lexical-table/src/LexicalGridSelection.ts:93


extract

extract(): LexicalNode[]

Returns

LexicalNode[]

Implementation of

BaseSelection.extract

Defined in

lexical-table/src/LexicalGridSelection.ts:101


getCachedNodes

getCachedNodes(): null | LexicalNode[]

Returns

null | LexicalNode[]

Implementation of

BaseSelection.getCachedNodes

Defined in

lexical-table/src/LexicalGridSelection.ts:66


getNodes

getNodes(): LexicalNode[]

Returns

LexicalNode[]

Implementation of

BaseSelection.getNodes

Defined in

lexical-table/src/LexicalGridSelection.ts:175


getShape

getShape(): GridSelectionShape

Returns

GridSelectionShape

Defined in

lexical-table/src/LexicalGridSelection.ts:126


getStartEndPoints

getStartEndPoints(): [PointType, PointType]

Returns

[PointType, PointType]

Implementation of

BaseSelection.getStartEndPoints

Defined in

lexical-table/src/LexicalGridSelection.ts:53


getTextContent

getTextContent(): string

Returns

string

Implementation of

BaseSelection.getTextContent

Defined in

lexical-table/src/LexicalGridSelection.ts:333


insertNodes

insertNodes(nodes): void

Parameters

NameType
nodesLexicalNode[]

Returns

void

Implementation of

BaseSelection.insertNodes

Defined in

lexical-table/src/LexicalGridSelection.ts:113


insertRawText

insertRawText(text): void

Parameters

NameType
textstring

Returns

void

Implementation of

BaseSelection.insertRawText

Defined in

lexical-table/src/LexicalGridSelection.ts:105


insertText

insertText(): void

Returns

void

Implementation of

BaseSelection.insertText

Defined in

lexical-table/src/LexicalGridSelection.ts:109


is

is(selection): boolean

Parameters

NameType
selectionnull | BaseSelection

Returns

boolean

Implementation of

BaseSelection.is

Defined in

lexical-table/src/LexicalGridSelection.ts:74


isBackward

isBackward(): boolean

Returns whether the Selection is "backwards", meaning the focus logically precedes the anchor in the EditorState.

Returns

boolean

true if the Selection is backwards, false otherwise.

Implementation of

BaseSelection.isBackward

Defined in

lexical-table/src/LexicalGridSelection.ts:62


isCollapsed

isCollapsed(): boolean

Returns

boolean

Implementation of

BaseSelection.isCollapsed

Defined in

lexical-table/src/LexicalGridSelection.ts:97


set

set(gridKey, anchorCellKey, focusCellKey): void

Parameters

NameType
gridKeystring
anchorCellKeystring
focusCellKeystring

Returns

void

Defined in

lexical-table/src/LexicalGridSelection.ts:85


setCachedNodes

setCachedNodes(nodes): void

Parameters

NameType
nodesnull | LexicalNode[]

Returns

void

Implementation of

BaseSelection.setCachedNodes

Defined in

lexical-table/src/LexicalGridSelection.ts:70