Type Editor

---

Type Editor / @type-editor/tables / utils/selection-range / getSelectionRangeInRow

Function: getSelectionRangeInRow()

function getSelectionRangeInRow(
  transaction,
  startRowIndex,
  endRowIndex?,
): CellSelectionRange;

Defined in: tables/src/utils/selection-range.ts:382

Returns a range of rectangular selection spanning all merged cells around a row at the specified index.

This function calculates the complete selection range needed to select entire rows, taking into account cells that span multiple rows. When a cell spans across the selection boundary, the selection is automatically expanded to include all rows covered by that cell.

Original implementation from Atlassian (Apache License 2.0)

Parameters

Parameter	Type	Default value	Description
transaction	PmTransaction	undefined	The ProseMirror transaction containing the current document state and selection information.
startRowIndex	number	undefined	The zero-based index of the first row to include in the selection. Must be a non-negative integer.
endRowIndex	number	startRowIndex	The zero-based index of the last row to include in the selection. Defaults to startRowIndex for single-row selection. Must be greater than or equal to startRowIndex.

Returns

CellSelectionRange

A CellSelectionRange object containing the anchor and head positions for the selection, along with all row indexes included. Returns undefined if the selection cannot be determined (e.g., invalid indexes or no table found).

See

https://bitbucket.org/atlassian/atlassian-frontend-mirror/src/5f91cb871e8248bc3bae5ddc30bb9fd9200fadbb/editor/editor-tables/src/utils/get-selection-range-in-row.ts

Example

// Select a single row
const range = getSelectionRangeInRow(tr, 0);

// Select multiple rows
const multiRange = getSelectionRangeInRow(tr, 1, 4);

if (range) {
  const cellSelection = CellSelection.create(
    tr.doc,
    range.$anchor.pos,
    range.$head.pos,
  );
  tr.setSelection(cellSelection);
}