LayoutRowSelection

Defines Row Selection behaviour in a Layout

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
CheckboxesbooleanWhether to display checkboxes in Selection Column. Overridden by LayoutOptions.isRowSelectionCheckboxVisible when that function is provided (except when RowSelection is false, which disables selection entirely).true
CheckboxInGroupColumnbooleanRenders selection checkboxes in Auto-Group Column (if true) or in dedicated Selection Column (if false)false
EnableClickSelectionboolean | 'enableDeselection' | 'enableSelection'Selection behaviour when clicking a row: 'enableSelection' | 'enableDeselection' | true | falsefalse
GroupSelectModeGroupSelectionModeGrouping Select Mode: 'self' | 'descendants' | 'filteredDescendants''self'
HeaderCheckboxbooleanWhether to show checkbox in Header of Selection Column Header ('multiRow' only)true
Mode'singleRow' | 'multiRow'Row Selection Mode: 'singleRow' or 'multiRow'
SelectAllModeSelectAllModeSelect All Mode: 'all' | 'filtered' | 'currentPage''all'

Property Details

Checkboxes

Whether to display checkboxes in Selection Column. Overridden by LayoutOptions.isRowSelectionCheckboxVisible when that function is provided (except when RowSelection is false, which disables selection entirely).

TypeScript
Checkboxes?: boolean;
Default Value

true

Property Value

boolean

CheckboxInGroupColumn

Renders selection checkboxes in Auto-Group Column (if true) or in dedicated Selection Column (if false)

TypeScript
CheckboxInGroupColumn?: boolean;
Default Value

false

Property Value

boolean

EnableClickSelection

Selection behaviour when clicking a row: 'enableSelection' | 'enableDeselection' | true | false

TypeScript
EnableClickSelection?: boolean | 'enableDeselection' | 'enableSelection';
Default Value

false

Property Value

boolean | 'enableDeselection' | 'enableSelection'

GroupSelectMode

Grouping Select Mode: 'self' | 'descendants' | 'filteredDescendants'

TypeScript
GroupSelectMode?: GroupSelectionMode;
Default Value

'self'

Property Value

GroupSelectionMode

HeaderCheckbox

Whether to show checkbox in Header of Selection Column Header ('multiRow' only)

TypeScript
HeaderCheckbox?: boolean;
Default Value

true

Property Value

boolean

Mode

Row Selection Mode: 'singleRow' or 'multiRow'

TypeScript
Mode: 'singleRow' | 'multiRow';
Property Value

'singleRow' | 'multiRow'

SelectAllMode

Select All Mode: 'all' | 'filtered' | 'currentPage'

TypeScript
SelectAllMode?: SelectAllMode;
Default Value

'all'

Property Value

SelectAllMode