TcxPivotGridField.GroupInterval Property

Specifies how the values of the current column field or row field are combined into groups.

Declaration

property GroupInterval: TcxPivotGridGroupInterval read; write; default giDefault;

Property Value

Type	Default
TcxPivotGridGroupInterval	giDefault

Remarks

Values of column fields or row fields can be combined into groups. By default, the control doesn’t group the values of these fields and displays all their unique values along its top and left edge, respectively. The GroupInterval property allows you to specify how field values are grouped together.

For instance, for a field that displays date-time values, you can set its GroupInterval property to giDateMonth. As a result, the field’s values will be grouped within a few categories (months), each of which will combine different values that belong to the same month.

You can provide custom grouping logic by setting the GroupInterval property to giCustom and handling the OnGetGroupValue and OnGetGroupValueDisplayText events.

All the available grouping modes are listed in the following table.

Value	Meaning
giDefault	Groups combine unique field values.
giDate	This option is relevant only for fields that store date-time values. Field values are grouped by the date part. The time part of the values is ignored.
giDateDay	This option is relevant only for fields that store date-time values. Field values are grouped by the day part. The following groups can be created: 1, 2, 3,…,31.
giDateDayOfWeek	This option is relevant only for fields that store date-time values. Field values are grouped by the days of the week. Examples of such groups: Sunday, Monday, Tuesday (the actual names of the days of the week are determined by the system’s regional settings).
giDateDayOfYear	This option is relevant only for fields that store date-time values. Field values are grouped by the number of the day in which they occur in a year. The following groups can be created: 1, 2, 3,…, 365 (,366 in a leap year).
giDateWeekOfMonth	This option is relevant only for fields that store date-time values. Field values are grouped by the number of the week in which they occur in a month. The following groups can be created: 1, 2, 3, 4 and 5. The first week includes the days 1 to 7, the second week days 8 to 14, the third week days 15 to 21, the fourth week days 22 to 28, the fifth week days 29 to 31.
giDateWeekOfYear	This option is relevant only for fields that store date-time values. Field values are grouped by the number of the week in which they occur in a year. The following groups can be created: 1, 2, 3,…,52, 53.
giDateMonth	This option is relevant only for fields that store date-time values. Field values are grouped by the month part. Examples of groups: January, February, March (the actual names of the months are determined by the system’s regional settings).
giDateQuarter	This option is relevant only for fields that store date-time values. Field values are grouped by the quarterly intervals of the year. The following groups can be created: 1, 2, 3 and 4. Each quarter includes three months.
giDateYear	This option is relevant only for fields that store date-time values. Field values are grouped by the year part. Examples of such groups: 2003, 2004, 2005.
giYearAge	This option is relevant only for fields that store date-time values. Field values are grouped by the number of years that have elapsed until the current date. The GroupIntervalRange property determines the intervals into which the values are grouped.
giMonthAge	This option is relevant only for fields that store date-time values. Field values are grouped by the number of months that have elapsed until the current date. The intervals into which the values are grouped are determined by the GroupIntervalRange property.
giWeekAge	This option is relevant only for fields that store date-time values. Field values are grouped by the number of weeks that have elapsed until the current date. The intervals into which the values are grouped are determined by the GroupIntervalRange property.
giDayAge	This option is relevant only for fields that store date-time values. Field values are grouped by the number of days that have elapsed until the current date. The intervals into which the values are grouped are determined by the GroupIntervalRange property.
giAlphabetical	Combines field values into categories according to the character that the values start with.
giNumeric	This option is relevant only for fields that store numeric values. Field values are grouped into intervals as specified by the GroupIntervalRange property.
giCustom	Custom grouping logic is provided by handling the OnGetGroupValue event. To specify user-friendly texts for custom grouping values, handle the OnGetGroupValueDisplayText event.

The default value of the GroupInterval property is giDefault.