SelectionModel | @lumino/datagrid

A base class for creating data grid selection models. The namespace for the SelectionModel class statics.

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

Interfaces

IOptions

Type aliases

Constructors

constructor

Properties

Accessors

Methods

Type aliases

Static ClearMode

ClearMode: "all" | "current" | "none"

A type alias for the clear mode.

Static CursorMoveDirection

CursorMoveDirection: "up" | "down" | "left" | "right" | "none"

A type alias for the cursor move direction.

Static SelectArgs

SelectArgs: object

A type alias for the select args.

Type declaration

Static Selection

Selection: object

A type alias for a selection in a selection model.

Type declaration

Static SelectionMode

SelectionMode: "row" | "column" | "cell"

A type alias for the selection mode.

Constructors

constructor

new SelectionModel(options: IOptions): SelectionModel

- Defined in datagrid/src/selectionmodel.ts:23
Construct a new selection model.

Parameters
- options: IOptions
  
  The options for initializing the model.
Returns SelectionModel

Properties

Private _changed

_changed: Signal<this, void> = new Signal<this, void>(this)

Private _selectionMode

_selectionMode: SelectionMode = "cell"

Abstract cursorColumn

cursorColumn: number

The column index of the cursor.

This is -1 if the selection model is empty.

Abstract cursorRow

cursorRow: number

The row index of the cursor.

This is -1 if the selection model is empty.

dataModel

dataModel: DataModel

The data model associated with the selection model.

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>

- Defined in datagrid/src/selectionmodel.ts:102
A signal emitted when the selection model has changed.

Returns ISignal<this, void>

selectionMode

get selectionMode(): SelectionMode
set selectionMode(value: SelectionMode): void

- Defined in datagrid/src/selectionmodel.ts:114
Get the selection mode for the model.

Notes

This will clear the selection model.

Returns SelectionMode
- Defined in datagrid/src/selectionmodel.ts:124
Set the selection mode for the model.

Notes

This will clear the selection model.

Parameters
- value: SelectionMode
Returns void

Methods

Abstract clear

clear(): void

- Defined in datagrid/src/selectionmodel.ts:97
Clear all selections in the selection model.

Returns void

Abstract currentSelection

currentSelection(): Selection | null

- Defined in datagrid/src/selectionmodel.ts:75
Get the current selection in the selection model.

Returns Selection | null

The current selection or null.

Notes

This is the selection which holds the cursor.

Protected emitChanged

emitChanged(): void

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

isCellSelected

isCellSelected(row: number, column: number): boolean

- Defined in datagrid/src/selectionmodel.ts:177
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.

isColumnSelected

isColumnSelected(index: number): boolean

- Defined in datagrid/src/selectionmodel.ts:161
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.

isRowSelected

isRowSelected(index: number): boolean

- Defined in datagrid/src/selectionmodel.ts:147
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.

Abstract moveCursorWithinSelections

moveCursorWithinSelections(direction: CursorMoveDirection): void

- Defined in datagrid/src/selectionmodel.ts:63
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

Protected onDataModelChanged

onDataModelChanged(sender: DataModel, args: ChangedArgs): void

- Defined in datagrid/src/selectionmodel.ts:192
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

Abstract select

select(args: SelectArgs): void

- Defined in datagrid/src/selectionmodel.ts:92
Select the specified cells.

Parameters
- args: SelectArgs
  
  The arguments for the selection.
Returns void

Abstract selections

selections(): IIterator<Selection>

- Defined in datagrid/src/selectionmodel.ts:85
Get an iterator of the selections in the model.

Returns IIterator<Selection>

A new iterator of the selections in the model.

Notes

The data grid will render the selections in order.

Notes

Hierarchy

Index

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static ClearMode

Static CursorMoveDirection

Static SelectArgs

Type declaration

Static Selection

Type declaration

Static SelectionMode

Constructors

constructor

Parameters

options: IOptions

Returns SelectionModel

Properties

Private _changed

Private _selectionMode

Abstract cursorColumn

Abstract cursorRow

dataModel

Abstract isEmpty

Notes

Accessors

changed

Returns ISignal<this, void>

selectionMode

Notes

Returns SelectionMode

Notes

Parameters

value: SelectionMode

Returns void

Methods

Abstract clear

Returns void

Abstract currentSelection

Returns Selection | null

Notes

Protected emitChanged

Notes

Returns void

isCellSelected

Parameters

row: number

column: number

Returns boolean

Notes

isColumnSelected

Parameters

index: number

Returns boolean

Notes

isRowSelected

Parameters

index: number

Returns boolean

Notes

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