SelectionSettings

23 Sep 20251 minute to read

Configures the selection behavior of the Grid.

Properties

allowColumnSelection boolean

If ‘allowColumnSelection’ set to true, then the user can able to select the columns.

Defaults to false

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.
  • BoxWithBorder: Selects the range of cells as like Box mode with borders.

Defaults to 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 Default

checkboxOnly boolean

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

To enable checkboxOnly selection, should specify the column type ascheckbox.

Defaults to false

enableSimpleMultiRowSelection boolean

If ‘enableSimpleMultiRowSelection’ set to true, then the user can able to perform multiple row selection with single clicks.

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

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

Defaults to Row

persistSelection boolean

If ‘persistSelection’ set to true, then the Grid selection is persisted on all operations.
For persisting selection in the Grid, 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 Single