Row Grouping

LyteNyte Grid allows you to group rows by one or more columns using the rowGroupModel property. This property accepts an array of column id strings, where each represents a groupable column.

Grouping Model

The rowGroupModel determines how the grid groups your data. Each item in the model creates a group level, resulting in special group rows that can have child rows. This creates a tree-like view of your data within the grid.

TODO;

To include a column in the grid's rowGroupModel, mark it as groupable by setting the rowGroupable property to true.

The Row Group Field

Use the rowGroupField property to group a column by a different key than its field property. This helps when you need to map between a column's value and a grouping key.

TODO;

The Row Group Column

When you apply row groups, LyteNyte Grid creates additional columns for these groups. The rowGroupDisplayMode property controls how these group columns appear.

Single Group Column

Set rowGroupDisplayMode to "single-column" to create one group column that expands and collapses row groups. This is the default option and uses space efficiently.

TODO;

Multiple Group Columns

Set rowGroupDisplayMode to "multi-column" to create one group column for each item in your row group model.

TODO;

Custom Group Columns

Set rowGroupDisplayMode to "custom" when you want to provide your own column for expanding or collapsing row groups. LyteNyte Grid won't create a group column automatically.

TODO;

Customizing Group Columns

Use the rowGroupColumnTemplate property to customize group columns. This property offers a simplified version of column configurations that LyteNyte Grid uses when creating group columns.

LyteNyte Grid provides helpful API methods for custom group columns:

• Use rowGroupToggle to toggle a row group's expansion state
• Use rowGroupIsExpanded to check if a group row is expanded

TODO;

Row Group Expansions

The rowGroupExpansions property tracks which row groups are expanded, determining when the grid displays children of a row group.

This property only contains values for some row groups. For groups not listed in expansions, the grid uses the rowGroupDefaultExpansion property. You can set this property to:

• A number: expands row groups up to that depth
• A boolean: determines if all groups are expanded by default

The depth refers to the position of the grouping in the row group model.

TODO;