Search results

Selection API in Vue Grid API component

The Selection module is used to handle cell and row selection.

Properties

selectedColumnsIndexes

number[]

@hidden

Methods

clearCellSelection

Deselects the currently selected cells.

Returns void

clearColumnSelection

Clear the column selection

Returns void

clearRowSelection

Deselects the currently selected rows.

Returns void

clearSelection

Deselects the currently selected rows and cells.

Returns void

getSelectedRecords

Gets the collection of selected records.

Returns Object[]

selectCell

Selects a cell by the given index.

Parameter Type Description
cellIndex IIndex Defines the row and column indexes.
isToggle (optional) boolean If set to true, then it toggles the selection.

Returns void

selectCells

Selects a collection of cells by row and column indexes.

Parameter Type Description
rowCellIndexes ISelectedCell[] Specifies the row and column indexes.

Returns void

selectCellsByRange

Selects a range of cells from start and end indexes.

Parameter Type Description
startIndex IIndex Specifies the row and column’s start index.
endIndex (optional) IIndex Specifies the row and column’s end index.

Returns void

selectColumn

Select the column by passing start column index

Returns void

selectColumnWithExisting

Select the column with existing column by passing column index

Parameter Type Description
startIndex number

Returns void

selectColumns

Select the columns by passing column indexes

Parameter Type Description
columnIndexes number[]

Returns void

selectColumnsByRange

Select the columns by passing start and end column index

Returns void

selectRow

Selects a row by the given index.

Parameter Type Description
index number Defines the row index.
isToggle (optional) boolean If set to true, then it toggles the selection.

Returns void

selectRows

Selects a collection of rows by index.

Parameter Type Description
rowIndexes number[] Specifies an array of row indexes.

Returns void

selectRowsByRange

Selects a range of rows from start and end row indexes.

Parameter Type Description
startIndex number Specifies the start row index.
endIndex (optional) number Specifies the end row index.

Returns void