Rowgroup

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

Signature:

export interface RowGroup

Remarks

When using GridView.setRowGroup(), you only need to enter the necessary information.

Example

gridView.setRowGroup({levelIndent: false});

Events

Property	Type	Description
createFooterCallback	CreateFooterCallback	A callback to specify whether to display a specific group footer
expanderVisibleCallback	ExpanderVisibleCallback	A callback that determines whether the expander is displayed
headerCallback	HeaderCallback	A callback that returns a string to display in the header
valueForGroupCallback	ValueForGroupCallback	It cannot be used in the callback RowGroup.mergeMode, which is used to create a group with a value other than the column value.

Properties

Property	Type	Description
blankGroupData	boolean	Whether to display data in group column
collapsedAdornments	RowGroupAdornments	When a row group is in a collapsed state, whether to display the group header and footer
expandedAdornments	RowGroupAdornments	When a row group is expanded, whether to display the group header and footer
expanderVisibility	ExpanderVisibility	expander visibility
footers	RowGroupFooterCollection	Specifies the number and style of low group footers.
headerStatement	string	Format string to display in header
indentVisible	boolean	Whether to display group expander area
indentVisibleLevel	number	To what level the group expander will be displayed
levelIndent	number	Indent margin between group levels
mergeExpanderVisibility	ExpanderVisibility	expander visibility
mergeMode	boolean	Whether to express merge of grouped columns
resetOriginVindex	boolean	When mergeMode is `true`, columns released from grouping are moved to their original positions.
sorting	boolean	Auto sort or not

Methods

Method	Type	Description
setFooters(footers)	setFooters?(footers: RowGroupFooter \| RowGroupFooter[]): void;

Events Desc

createFooterCallback

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

Type - CreateFooterCallback

Remarks:

If RowGroup.mergeMode is true, you can specify whether to display some group footers. Returns the value true if you wish to display it.

expanderVisibleCallback

A callback that determines whether the expander is displayed.

Type - ExpanderVisibleCallback

headerCallback

A callback that returns a string to display in the header

Type - HeaderCallback

Remarks:

RowGroup.headerStatement is ignored if present.

valueForGroupCallback

It cannot be used in the callback RowGroup.mergeMode, which is used when creating a group with a value other than the column value.

Type - 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.

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 is true.

collapsedAdornments

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

Type - RowGroupAdornments

expandedAdornments

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

Type - RowGroupAdornments

expanderVisibility

expander visibility

Type - ExpanderVisibility

footers

Specifies the number and style of low group footers.

Type - RowGroupFooterCollection

headerStatement

Format string to display in header

Type - string

indentVisible

Whether to display group expander area

Type - boolean

indentVisibleLevel

What level the group expander will be displayed at.

Type - number

Remarks:

RowGroup.expandedAdornments, RowGroup.collapsedAdornments is RowGroupAdornments.FOOTER or RowGroupAdornments.SUMMARY. 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.

levelIndent

Indent margin between group levels

Type - number

mergeExpanderVisibility

Warning: This API is now obsolete.

Replaced by expanderVisibility.

expander visibility

Type - ExpanderVisibility

mergeMode

Whether to express merge of grouped columns

Type - boolean

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.

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.

Method Desc

setFooters

Warning: This API is now obsolete.

Specify the number and style of low group footers.

[Parameter List]

footers - RowGroupFooter | RowGroupFooter[]

RowGroupFooter or an array

[Return Value] - void

RendererEditResult RowGroupFooter