@serenity-is/sleekgrid / RowSelectionModel

Class: RowSelectionModel

Defined in: src/plugins/rowselectionmodel.ts:40

Selection model that treats selection as whole rows (full-width ranges). Supports ActiveCell-driven selection, Shift+Up/Down range extension and Ctrl/Meta/Shift-click row toggling. Implements SelectionModel.

Implements

• GridPlugin
• SelectionModel

Constructors

Constructor

new RowSelectionModel(options?): RowSelectionModel

Defined in: src/plugins/rowselectionmodel.ts:55

Creates the selection model.

Parameters

options?

RowSelectionModelOptions

Partial options merged with RowSelectionModel.defaults.

Returns

RowSelectionModel

Properties

onSelectedRangesChanged

onSelectedRangesChanged: EventEmitter<CellRange[]>

Defined in: src/plugins/rowselectionmodel.ts:49

Emits when selected ranges change; used by the grid to update UI state.

Implementation of

SelectionModel.onSelectedRangesChanged

---

defaults

readonly static defaults: RowSelectionModelOptions

Defined in: src/plugins/rowselectionmodel.ts:60

Default option values.

Methods

destroy()

destroy(): void

Defined in: src/plugins/rowselectionmodel.ts:78

Unsubscribes handlers installed by RowSelectionModel.init.

Returns

void

Implementation of

SelectionModel.destroy

---

getSelectedRanges()

getSelectedRanges(): CellRange[]

Defined in: src/plugins/rowselectionmodel.ts:134

Returns the current selection as full-width CellRange objects.

Returns

CellRange[]

Current selected ranges.

---

getSelectedRows()

getSelectedRows(): number[]

Defined in: src/plugins/rowselectionmodel.ts:106

Returns selected view row indices derived from the internal ranges.

Returns

number[]

Array of selected row indices.

---

init()

init(grid): void

Defined in: src/plugins/rowselectionmodel.ts:68

Attaches to onActiveCellChanged, onKeyDown and onClick on grid.

Parameters

grid

ISleekGrid

Host grid instance.

Returns

void

Implementation of

SelectionModel.init

---

setSelectedRanges()

setSelectedRanges(ranges): void

Defined in: src/plugins/rowselectionmodel.ts:122

Sets selection from explicit ranges (each range should span the full row width).

Parameters

ranges

CellRange[]

Cell ranges representing row selection.

Returns

void

Implementation of

SelectionModel.setSelectedRanges

---

setSelectedRows()

setSelectedRows(rows): void

Defined in: src/plugins/rowselectionmodel.ts:114

Sets selection from a list of row indices.

Parameters

rows

number[]

Row indices to select.

Returns

void