Class SelectionModel`Abstract`

A base class for creating data grid selection models.

Notes

If the predefined selection models are insufficient for a particular use case, a custom model can be defined which derives from this class.

Hierarchy (view full)

SelectionModel
- BasicSelectionModel

Index

Constructors

constructor

new SelectionModel(options): SelectionModel
Construct a new selection model.
Parameters
- options: SelectionModel.IOptions
  The options for initializing the model.
Returns SelectionModel
- Defined in datagrid/src/selectionmodel.ts:29

Properties

`Private` _changed

_changed: Signal<SelectionModel, void> = ...

`Private` _selectionMode

_selectionMode: SelectionMode = 'cell'

`Abstract` `Readonly` cursorColumn

cursorColumn: number

The column index of the cursor.

This is -1 if the selection model is empty.

`Abstract` `Readonly` cursorRow

cursorRow: number

The row index of the cursor.

This is -1 if the selection model is empty.

`Readonly` dataModel

dataModel: DataModel

The data model associated with the selection model.

`Abstract` `Readonly` isEmpty

isEmpty: boolean

Whether the selection model is empty.

Notes

An empty selection model will yield an empty selections iterator.

Accessors

changed

get changed(): ISignal<this, void>
A signal emitted when the selection model has changed.

Returns ISignal<this, void>
- Defined in datagrid/src/selectionmodel.ts:102

selectionMode

get selectionMode(): SelectionMode
Get the selection mode for the model.

Returns SelectionMode
- Defined in datagrid/src/selectionmodel.ts:114
set selectionMode(value): void
Set the selection mode for the model.

Notes
This will clear the selection model.
Parameters
- value: SelectionMode
Returns void
- Defined in datagrid/src/selectionmodel.ts:124

Methods

`Abstract` clear

clear(): void
Clear all selections in the selection model.

Returns void
- Defined in datagrid/src/selectionmodel.ts:97

`Abstract` currentSelection

currentSelection(): null | Selection
Get the current selection in the selection model.

Returns null | Selection
The current selection or null.

Notes
This is the selection which holds the cursor.
- Defined in datagrid/src/selectionmodel.ts:75

`Protected` emitChanged

emitChanged(): void
Emit the changed signal for the selection model.

Notes
Subclasses should call this method whenever the selection model has changed so that attached data grids can update themselves.

Returns void
- Defined in datagrid/src/selectionmodel.ts:206

isCellSelected

isCellSelected(row, column): boolean
Test whether any selection intersects a cell.
Parameters
- row: number
  The row index of interest.
- column: number
  The column index of interest.
Returns boolean
Whether any selection intersects the cell.

Notes
This method may be reimplemented in a subclass.
- Defined in datagrid/src/selectionmodel.ts:177

isColumnSelected

isColumnSelected(index): boolean
Test whether any selection intersects a column.
Parameters
- index: number
  The column index of interest.
Returns boolean
Whether any selection intersects the column.

Notes
This method may be reimplemented in a subclass.
- Defined in datagrid/src/selectionmodel.ts:161

isRowSelected

isRowSelected(index): boolean
Test whether any selection intersects a row.
Parameters
- index: number
  The row index of interest.
Returns boolean
Whether any selection intersects the row.

Notes
This method may be reimplemented in a subclass.
- Defined in datagrid/src/selectionmodel.ts:147

`Abstract` moveCursorWithinSelections

moveCursorWithinSelections(direction): void
Move cursor down/up/left/right while making sure it remains within the bounds of selected rectangles
Parameters
- direction: CursorMoveDirection
  The direction of the movement.
Returns void
- Defined in datagrid/src/selectionmodel.ts:63

`Protected` onDataModelChanged

onDataModelChanged(sender, args): void
A signal handler for the data model changed signal.
Parameters
- sender: DataModel
- args: ChangedArgs
  The arguments for the signal.
  
  Notes
  Selection model implementations should update their selections in a manner that is relevant for the changes to the data model.
  
  The default implementation of this method is a no-op.
Returns void
- Defined in datagrid/src/selectionmodel.ts:192

`Abstract` select

select(args): void
Select the specified cells.
Parameters
- args: SelectArgs
  The arguments for the selection.
Returns void
- Defined in datagrid/src/selectionmodel.ts:92

`Abstract` selections

selections(): IterableIterator<Selection>
Get an iterator of the selections in the model.

Returns IterableIterator<Selection>
A new iterator of the selections in the model.

Notes
The data grid will render the selections in order.
- Defined in datagrid/src/selectionmodel.ts:85

Class SelectionModelAbstract

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SelectionModel

Properties

Private _changed

Private _selectionMode

Abstract Readonly cursorColumn

Abstract Readonly cursorRow

Readonly dataModel

Abstract Readonly isEmpty

Accessors

changed

Returns ISignal<this, void>

selectionMode

Returns SelectionMode

Parameters

Returns void

Methods

Abstract clear

Returns void

Abstract currentSelection

Returns null | Selection

Protected emitChanged

Returns void

isCellSelected

Parameters

Returns boolean

isColumnSelected

Parameters

Returns boolean

isRowSelected

Parameters

Returns boolean

Abstract moveCursorWithinSelections

Parameters

Returns void

Protected onDataModelChanged

Parameters

Returns void

Abstract select

Parameters

Returns void

Abstract selections

Returns IterableIterator<Selection>

Settings

Member Visibility

Theme

On This Page

Class SelectionModel`Abstract`

`Private` _changed

`Private` _selectionMode

`Abstract` `Readonly` cursorColumn

`Abstract` `Readonly` cursorRow

`Readonly` dataModel

`Abstract` `Readonly` isEmpty

`Abstract` clear

`Abstract` currentSelection

`Protected` emitChanged

`Abstract` moveCursorWithinSelections

`Protected` onDataModelChanged

`Abstract` select

`Abstract` selections