Search results

GroupSettings API in JavaScript (ES5) Grid API control

Configures the group behavior of the Grid.

Properties

allowReordering

boolean

If allowReordering is set to true, Grid allows the grouped elements to be reordered.

Defaults to false

captionTemplate

string | Object | Function

The Caption Template allows user to display the string or HTML element in group caption.

It accepts either the template string or the HTML element ID.

Defaults to null

columns

string[]

Specifies the column names to group at initial rendering of the Grid. You can also get the currently grouped columns.

Defaults to []

disablePageWiseAggregates

boolean

If disablePageWiseAggregates set to true, then the group aggregate value will be calculated from the whole data instead of paged data and two requests will be made for each page when Grid bound with remote service.

Defaults to false

enableLazyLoading

boolean

The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping. The child rows of each caption will render only when we expand the captions.

Defaults to false

showDropArea

boolean

If showDropArea is set to true, the group drop area element will be visible at the top of the Grid.

Defaults to true

showGroupedColumn

boolean

If showGroupedColumn is set to false, it hides the grouped column after grouping.

Defaults to false

showToggleButton

boolean

If showToggleButton set to true, then the toggle button will be showed in the column headers which can be used to group or ungroup columns by clicking them.

Defaults to false

showUngroupButton

boolean

If showUngroupButton set to false, then ungroup button is hidden in dropped element. It can be used to ungroup the grouped column when click on ungroup button.

Defaults to true