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

SelectionModel
- BasicSelectionModel

Index

Constructors

constructor

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

Properties

`Private` _changed

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

`Private` _selectionMode

_selectionMode: SelectionMode = 'cell'

`Readonly` `Abstract` cursorColumn

cursorColumn: number

The column index of the cursor.

This is -1 if the selection model is empty.

`Readonly` `Abstract` 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.

`Readonly` `Abstract` 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 packages/datagrid/src/selectionmodel.ts:102

selectionMode

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

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

Notes

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

Methods

`Abstract` clear

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

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

`Abstract` currentSelection

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

Returns
The current selection or null.

Notes

This is the selection which holds the cursor.

Returns null | Selection
- Defined in packages/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 packages/datagrid/src/selectionmodel.ts:206

isCellSelected

isCellSelected(row: number, column: number): boolean
Test whether any selection intersects a cell.

Returns
Whether any selection intersects the cell.

Notes

This method may be reimplemented in a subclass.
Parameters
- row: number
  
  The row index of interest.
- column: number
  
  The column index of interest.
Returns boolean
- Defined in packages/datagrid/src/selectionmodel.ts:177

isColumnSelected

isColumnSelected(index: number): boolean
Test whether any selection intersects a column.

Returns
Whether any selection intersects the column.

Notes

This method may be reimplemented in a subclass.
Parameters
- index: number
  
  The column index of interest.
Returns boolean
- Defined in packages/datagrid/src/selectionmodel.ts:161

isRowSelected

isRowSelected(index: number): boolean
Test whether any selection intersects a row.

Returns
Whether any selection intersects the row.

Notes

This method may be reimplemented in a subclass.
Parameters
- index: number
  
  The row index of interest.
Returns boolean
- Defined in packages/datagrid/src/selectionmodel.ts:147

`Abstract` moveCursorWithinSelections

moveCursorWithinSelections(direction: CursorMoveDirection): 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 packages/datagrid/src/selectionmodel.ts:63

`Protected` onDataModelChanged

onDataModelChanged(sender: DataModel, args: ChangedArgs): 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 packages/datagrid/src/selectionmodel.ts:192

`Abstract` select

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

`Abstract` selections

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

Returns
A new iterator of the selections in the model.

Notes

The data grid will render the selections in order.

Returns IterableIterator<Selection>
- Defined in packages/datagrid/src/selectionmodel.ts:85

Class SelectionModelAbstract

Notes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: SelectionModel.IOptions

Returns SelectionModel

Properties

Private _changed

Private _selectionMode

Readonly Abstract cursorColumn

Readonly Abstract cursorRow

Readonly dataModel

Readonly Abstract isEmpty

Notes

Accessors

changed

Returns ISignal<this, void>

selectionMode

Returns SelectionMode

Notes

Parameters

value: SelectionMode

Returns void

Methods

Abstract clear

Returns void

Abstract currentSelection

Returns

Notes

Returns null | Selection

Protected emitChanged

Notes

Returns void

isCellSelected

Returns

Notes

Parameters

row: number

column: number

Returns boolean

isColumnSelected

Returns

Notes

Parameters

index: number

Returns boolean

isRowSelected

Returns

Notes

Parameters

index: number

Returns boolean

Abstract moveCursorWithinSelections

Parameters

direction: CursorMoveDirection

Returns void

Protected onDataModelChanged

Parameters

sender: DataModel

args: ChangedArgs

Notes

Returns void

Abstract select

Parameters

args: SelectArgs

Returns void

Abstract selections

Returns

Notes

Returns IterableIterator<Selection>

Settings

Member Visibility

Theme

Class SelectionModel`Abstract`

`Private` _changed

`Private` _selectionMode

`Readonly` `Abstract` cursorColumn

`Readonly` `Abstract` cursorRow

`Readonly` dataModel

`Readonly` `Abstract` isEmpty

`Abstract` clear

`Abstract` currentSelection

`Protected` emitChanged

`Abstract` moveCursorWithinSelections

`Protected` onDataModelChanged

`Abstract` select

`Abstract` selections