Search results

Selection API in JavaScript Gantt API control

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

Methods

clearSelection

Deselects the current selected rows and cells.

Returns void

getCellSelectedRecords

Get the selected records for cell selection.

Returns IGanttData[]

getSelectedRecords

Gets the collection of selected records.

Returns Object[]

getSelectedRowCellIndexes

Gets the collection of selected row and cell indexes.

Returns ISelectedCell[]

getSelectedRowIndexes

Gets the collection of selected row indexes.

Returns number[]

getSelectedRows

Gets the collection of selected rows.

Returns Element[]

selectCell

Selects a cell by 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

selectRow

Selects a row by given index.

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

Returns void

selectRows

Selects a collection of rows by indexes.

Parameter Type Description
records number[] Defines the collection of row indexes.

Returns void

selectRowsByRange

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

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

Returns void