{/* Do not edit this file. It is automatically generated by API Documenter. */}


## GroupingOptions

Settings model related to row grouping

**Signature:**

```typescript
export interface GroupingOptions
```

## Remarks

Row grouping divides data rows based on the values of one or more specified columns and displays them in a hierarchical structure.

When setting it as an option in [Grid](/refs/Class/GridBase), you only need to enter the necessary information.

## Example


```js
grid.setGroupingOptions({prompt: "I am Group"});
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [commitBeforeCollapse](/refs/Interface/GroupingOptions#commitbeforecollapse) | boolean | |
| [commitBeforeExpand](/refs/Interface/GroupingOptions#commitbeforeexpand) | boolean | |
| [commitBeforeGrouping](/refs/Interface/GroupingOptions#commitbeforegrouping) | boolean | |
| [enabled](/refs/Interface/GroupingOptions#enabled) | boolean | Whether to enable grouping |
| [expandWhenGrouping](/refs/Interface/GroupingOptions#expandwhengrouping) | boolean | Whether to expand the group when grouping |
| [fixMergedColumns](/refs/Interface/GroupingOptions#fixmergedcolumns) | boolean | **_(ALPHA)_** Whether to fix merged columns |
| [prompt](/refs/Interface/GroupingOptions#prompt) | string | Message to be displayed on panel |
| [summarizing](/refs/Interface/GroupingOptions#summarizing) | boolean | **_(ALPHA)_** |
| [toast](/refs/Interface/GroupingOptions#toast) | [ToastOptions](/refs/Interface/ToastOptions) | Toast-related settings |

## Properties Desc

### commitBeforeCollapse

> Warning: This API is now obsolete.
>
> Commit before group collapse
>

`Type` - boolean

<hr/>

### commitBeforeExpand

> Warning: This API is now obsolete.
>
> Commit before group expansion
>

`Type` - boolean

<hr/>

### commitBeforeGrouping

> Warning: This API is now obsolete.
>
> Commit before grouping
>

`Type` - boolean

<hr/>

### enabled

Whether grouping is enabled or not

`Type` - boolean

<hr/>

### expandWhenGrouping

Whether to expand the group when grouping

`Type` - boolean

<hr/>

### fixMergedColumns

Whether to fix merged columns

`Type` - boolean

<hr/>

### prompt

Message to be displayed on panel

`Type` - string

<hr/>

### summarizing

`Type` - boolean

<hr/>

### toast

Toast-related settings

`Type` - [ToastOptions](/refs/Interface/ToastOptions)

<hr/>