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


## RowGroup

Setting model for how to display areas related to row grouping, etc.

**Signature:**

```typescript
export interface RowGroup
```

## Remarks

When using [GridView.setRowGroup()](/refs/Class/GridView#setrowgroup), you only need to enter the necessary information.

## Example


```js
gridView.setRowGroup({levelIndent: false});
```

## Events

| Property | Type | Description |
| --- | --- | --- |
| [createFooterCallback](/refs/Interface/RowGroup#createfootercallback) | [CreateFooterCallback](/refs/realgrid#createfootercallback) | A callback to specify whether to display a specific group footer |
| [expanderVisibleCallback](/refs/Interface/RowGroup#expandervisiblecallback) | [ExpanderVisibleCallback](/refs/realgrid#expandervisiblecallback) | A callback that determines whether the expander is displayed |
| [headerCallback](/refs/Interface/RowGroup#headercallback) | [HeaderCallback](/refs/realgrid#headercallback) | A callback that returns a string to display in the header |
| [valueForGroupCallback](/refs/Interface/RowGroup#valueforgroupcallback) | [ValueForGroupCallback](/refs/realgrid#valueforgroupcallback) | It cannot be used in the callback [RowGroup.mergeMode](/refs/Interface/RowGroup#mergemode){/* */}, which is used to create a group with a value other than the column value. |

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [blankGroupData](/refs/Interface/RowGroup#blankgroupdata) | boolean | Whether to display data in group column |
| [collapsedAdornments](/refs/Interface/RowGroup#collapsedadornments) | [RowGroupAdornments](/refs/realgrid#rowgroupadornments) | When a row group is in a collapsed state, whether to display the group header and footer |
| [expandedAdornments](/refs/Interface/RowGroup#expandedadornments) | [RowGroupAdornments](/refs/realgrid#rowgroupadornments) | When a row group is expanded, whether to display the group header and footer |
| [expanderVisibility](/refs/Interface/RowGroup#expandervisibility) | [ExpanderVisibility](/refs/realgrid#expandervisibility) | expander visibility |
| [footers](/refs/Interface/RowGroup#footers) | [RowGroupFooterCollection](/refs/Interface/RowGroupFooterCollection) | Specifies the number and style of low group footers. |
| [headerMultiRowsOnly](/refs/Interface/RowGroup#headermultirowsonly) | boolean | Whether to display the group header only if the group contains multiple dataRows. |
| [headerStatement](/refs/Interface/RowGroup#headerstatement) | string | Format string to display in header |
| [headerVisibleCallback](/refs/Interface/RowGroup#headervisiblecallback) | HeaderVisibleCallback | Callback for specifying whether a specific group header is visible |
| [indentVisible](/refs/Interface/RowGroup#indentvisible) | boolean | Whether to display group expander area |
| [indentVisibleLevel](/refs/Interface/RowGroup#indentvisiblelevel) | number | To what level the group expander will be displayed |
| [levelIndent](/refs/Interface/RowGroup#levelindent) | number | Indent margin between group levels |
| [mergeExpanderVisibility](/refs/Interface/RowGroup#mergeexpandervisibility) | [ExpanderVisibility](/refs/realgrid#expandervisibility) | expander visibility |
| [mergeMode](/refs/Interface/RowGroup#mergemode) | boolean | Whether to express merge of grouped columns |
| [resetOriginVindex](/refs/Interface/RowGroup#resetoriginvindex) | boolean | When mergeMode is `true`{/* */}, columns released from grouping are moved to their original positions. |
| [sorting](/refs/Interface/RowGroup#sorting) | boolean | Auto sort or not |

## Methods

| Method | Type | Description |
| --- | --- | --- |
| [setFooters(footers)](/refs/Interface/RowGroup#setfooters) | setFooters?(footers: [RowGroupFooter](/refs/Interface/RowGroupFooter) \| [RowGroupFooter](/refs/Interface/RowGroupFooter){/* */}\[\]): void; | |

## Events Desc

### createFooterCallback

A callback to specify whether a specific group footer should be displayed.

`Type` - [CreateFooterCallback](/refs/realgrid#createfootercallback)

**Remarks:**

If [RowGroup.mergeMode](/refs/Interface/RowGroup#mergemode) is `true`, you can specify whether to display some group footers. Returns the value `true` if you wish to display it.

<hr/>

### expanderVisibleCallback

A callback that determines whether the expander is displayed.

`Type` - [ExpanderVisibleCallback](/refs/realgrid#expandervisiblecallback)

<hr/>

### headerCallback

A callback that returns a string to display in the header

`Type` - [HeaderCallback](/refs/realgrid#headercallback)

**Remarks:**

[RowGroup.headerStatement](/refs/Interface/RowGroup#headerstatement){/* */} is ignored if present.

<hr/>

### valueForGroupCallback

It cannot be used in the callback [RowGroup.mergeMode](/refs/Interface/RowGroup#mergemode){/* */}, which is used when creating a group with a value other than the column value.

`Type` - [ValueForGroupCallback](/refs/realgrid#valueforgroupcallback)

**Remarks:**

Used to create a group by combining some values of a column or other columns. Since a callback is called after sorting the data, if separate sorting is necessary, sort using [User-defined sort function](/refs/Class/DataProviderBase#setdatacomparer){/* */}.

<hr/>

## Properties Desc

### blankGroupData

Whether to display data in group columns

`Type` - boolean

**Remarks:**

If `true`{/* */}, only the first data in the group is displayed. Not applied when [RowGroup.mergeMode](/refs/Interface/RowGroup#mergemode) is `true`{/* */}.

<hr/>

### collapsedAdornments

When a row group is collapsed, whether to display the group header and footer.

`Type` - [RowGroupAdornments](/refs/realgrid#rowgroupadornments)

<hr/>

### expandedAdornments

When a row group is expanded, whether to display the group header and footer.

`Type` - [RowGroupAdornments](/refs/realgrid#rowgroupadornments)

<hr/>

### expanderVisibility

expander visibility

`Type` - [ExpanderVisibility](/refs/realgrid#expandervisibility)

<hr/>

### footers

Specifies the number and style of low group footers.

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

<hr/>

### headerMultiRowsOnly

Whether to display the group header only when the group contains multiple data rows.

`Type` - boolean

**Remarks:**

Applies only when the group is expanded.

<hr/>

### headerStatement

Format string to display in header

`Type` - string

<hr/>

### headerVisibleCallback

A callback that specifies whether a specific group header is visible.

`Type` - HeaderVisibleCallback

**Remarks:**

Applies only when the group is expanded.

<hr/>

### indentVisible

Whether to display group expander area

`Type` - boolean

<hr/>

### indentVisibleLevel

What level the group expander will be displayed at.

`Type` - number

**Remarks:**

[RowGroup.expandedAdornments](/refs/Interface/RowGroup#expandedadornments){/* */}, [RowGroup.collapsedAdornments](/refs/Interface/RowGroup#collapsedadornments){/* */} is [RowGroupAdornments.FOOTER]( /refs/realgrid#rowgroupadornments) or [RowGroupAdornments.SUMMARY](/refs/realgrid#rowgroupadornments). `0` The entire level is displayed. If it is a positive or negative number, it is displayed up to the set level. If the group is 3 levels, setting it to `1`{/* */} will show only level 1, and setting it to `-1`{/* */} will show only level 3.

<hr/>

### levelIndent

Indent margin between group levels

`Type` - number

<hr/>

### mergeExpanderVisibility

> Warning: This API is now obsolete.
>
> Replaced by expanderVisibility.
>

expander visibility

`Type` - [ExpanderVisibility](/refs/realgrid#expandervisibility)

<hr/>

### mergeMode

Whether to express merge of grouped columns

`Type` - boolean

<hr/>

### resetOriginVindex

When mergeMode is `true`{/* */}, columns released from grouping are moved to their original positions.

`Type` - boolean

**Remarks:**

If you move a column or change its visibility after grouping, it cannot be returned to its normal location.

<hr/>

### sorting

Auto-sort or not

`Type` - boolean

**Remarks:**

If set to `false`{/* */}, rows are not automatically sorted when grouping rows, but rows are grouped in the order of data displayed in the grid.

<hr/>

## Method Desc

### setFooters

> Warning: This API is now obsolete.
>
> Specify the number and style of low group footers.
>

**\[Parameter List\]**

`footers` - [RowGroupFooter](/refs/Interface/RowGroupFooter) \| [RowGroupFooter](/refs/Interface/RowGroupFooter){/* */}\[\]

[RowGroupFooter](/refs/Interface/RowGroupFooter) or an array

**\[Return Value\] -** void

<hr/>