LayoutRowSelection

Defines Row Selection behaviour in a Layout

TypeScript
export interface

Properties

PropertyDescriptionDefault
CheckboxesWhether to display checkboxes in Selection Columntrue
CheckboxInGroupColumnRenders selection checkboxes in Auto-Group Column (if true) or in dedicated Selection Column (if false)false
EnableClickSelectionSelection behaviour when clicking a row: 'enableSelection' | 'enableDeselection' | true | falsefalse
GroupSelectModeGrouping Select Mode: 'self' | 'descendants' | 'filteredDescendants''self'
HeaderCheckboxWhether to show checkbox in Header of Selection Column Header ('multiRow' only)true
ModeRow Selection Mode: 'singleRow' or 'multiRow'
SelectAllModeSelect All Mode: 'all' | 'filtered' | 'currentPage''all'

Property Details

Checkboxes

Whether to display checkboxes in Selection Column

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