Class: GridSelection

lexical.GridSelection

Hierarchy

• PointSelection

  ↳ GridSelection

Constructors

constructor

• new GridSelection(gridKey, anchor, focus)

Parameters

Name	Type
gridKey	string
anchor	PointType
focus	PointType

Overrides

PointSelection.constructor

Defined in

lexical/src/LexicalSelection.ts:542

Properties

_cachedNodes

• _cachedNodes: null | LexicalNode[]

Inherited from

PointSelection._cachedNodes

Defined in

lexical/src/LexicalSelection.ts:281

---

anchor

• anchor: PointType

Inherited from

PointSelection.anchor

Defined in

lexical/src/LexicalSelection.ts:278

---

dirty

• dirty: boolean

Inherited from

PointSelection.dirty

Defined in

lexical/src/LexicalSelection.ts:280

---

focus

• focus: PointType

Inherited from

PointSelection.focus

Defined in

lexical/src/LexicalSelection.ts:279

---

gridKey

• gridKey: string

Defined in

lexical/src/LexicalSelection.ts:540

Methods

clone

▸ clone(): GridSelection

Returns

GridSelection

Overrides

PointSelection.clone

Defined in

lexical/src/LexicalSelection.ts:574

---

extract

▸ extract(): LexicalNode[]

Returns

LexicalNode[]

Overrides

PointSelection.extract

Defined in

lexical/src/LexicalSelection.ts:582

---

getCachedNodes

▸ getCachedNodes(): null | LexicalNode[]

Returns

null | LexicalNode[]

Overrides

PointSelection.getCachedNodes

Defined in

lexical/src/LexicalSelection.ts:547

---

getCharacterOffsets

▸ getCharacterOffsets(): [number, number]

Returns the character-based offsets of the Selection, accounting for non-text Points by using the children size or text content.

Returns

[number, number]

the character offsets for the Selection

Inherited from

PointSelection.getCharacterOffsets

Defined in

lexical/src/LexicalSelection.ts:355

---

getNodes

▸ getNodes(): LexicalNode[]

Returns

LexicalNode[]

Overrides

PointSelection.getNodes

Defined in

lexical/src/LexicalSelection.ts:652

---

getShape

▸ getShape(): GridSelectionShape

Returns

GridSelectionShape

Defined in

lexical/src/LexicalSelection.ts:603

---

getTextContent

▸ getTextContent(): string

Returns

string

Overrides

PointSelection.getTextContent

Defined in

lexical/src/LexicalSelection.ts:810

---

insertNodes

▸ insertNodes(nodes): void

Parameters

Name	Type
nodes	LexicalNode[]

Returns

void

Overrides

PointSelection.insertNodes

Defined in

lexical/src/LexicalSelection.ts:594

---

insertRawText

▸ insertRawText(text): void

Parameters

Name	Type
text	string

Returns

void

Overrides

PointSelection.insertRawText

Defined in

lexical/src/LexicalSelection.ts:586

---

insertText

▸ insertText(): void

Returns

void

Overrides

PointSelection.insertText

Defined in

lexical/src/LexicalSelection.ts:590

---

is

▸ is(selection): boolean

Parameters

Name	Type
selection	null | BaseSelection

Returns

boolean

Overrides

PointSelection.is

Defined in

lexical/src/LexicalSelection.ts:555

---

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.

Inherited from

PointSelection.isBackward

Defined in

lexical/src/LexicalSelection.ts:345

---

isCollapsed

▸ isCollapsed(): boolean

Returns

boolean

Overrides

PointSelection.isCollapsed

Defined in

lexical/src/LexicalSelection.ts:578

---

set

▸ set(gridKey, anchorCellKey, focusCellKey): void

Parameters

Name	Type
gridKey	string
anchorCellKey	string
focusCellKey	string

Returns

void

Defined in

lexical/src/LexicalSelection.ts:566

---

setCachedNodes

▸ setCachedNodes(nodes): void

Parameters

Name	Type
nodes	null | LexicalNode[]

Returns

void

Overrides

PointSelection.setCachedNodes

Defined in

lexical/src/LexicalSelection.ts:551