SelectionSettings API in JavaScript (ES5) TreeGrid API control

Configures the selection behavior of the TreeGrid.

Properties

cellSelectionMode

CellSelectionMode

The cell selection modes are flow and box. It requires the selection mode to be either cell or both.

• Flow: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
• Box: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.

Defaults to Syncfusion.EJ2.Grids.CellSelectionMode.Flow

checkboxMode

CheckboxSelectionType

Defines options for checkbox selection Mode. They are

• Default: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
• ResetOnRowClick: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple rows can be selected by using CTRL or SHIFT key.

Defaults to Syncfusion.EJ2.Grids.CheckboxSelectionType.Default

checkboxOnly

boolean

If ‘checkboxOnly’ set to true, then the TreeGrid selection is allowed only through checkbox.

To enable checkboxOnly selection, should specify the column type as checkbox.

Defaults to false

enableToggle

boolean

If ‘enableToggle’ set to true, then the user can able to perform toggle for the selected row.

Defaults to true

mode

SelectionMode

TreeGrid supports row, cell, and both (row and cell) selection mode.

Defaults to Syncfusion.EJ2.Grids.SelectionMode.Row

persistSelection

boolean

If ‘persistSelection’ set to true, then the TreeGrid selection is persisted on all operations. For persisting selection in the TreeGrid, any one of the column should be enabled as a primary key.

Defaults to false

type

SelectionType

Defines options for selection type. They are

• Single: Allows selection of only a row or a cell.
• Multiple: Allows selection of multiple rows or cells.

Defaults to Syncfusion.EJ2.Grids.SelectionType.Single