FieldGroupInterval Enum

Contains values that specify how the values of a specific column or row field are combined into groups.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v19.2.dll

Declaration

public enum FieldGroupInterval
Public Enum FieldGroupInterval

Members

Name Description
Default

Groups combine unique field values.

Date

This option is in effect only for fields that store date/time values.

Field values are grouped by the date part. The time part of the values is ignored.

DateDay

This option is in effect 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.

DateDayOfWeek

This option is in effect 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 current culture).

DateDayOfYear

This option is in effect 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).

DateWeekOfMonth

This option is in effect 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 is the week containing the 1st day of the month.

DateWeekOfYear

This option is in effect only for fields that store date/time values.

Field values are grouped by the number of the week in a year in which they occur. The following groups can be created: 1, 2, 3,...,52, 53.

DateMonth

This option is in effect 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 current culture).

DateQuarter

This option is in effect only for fields that store date/time values.

Field values are sorted by the quarterly intervals of the year. The following groups can be created: 1, 2, 3 and 4. Each quarter includes three months.

DateYear

This option is in effect only for fields that store date/time values.

Field values are grouped by the year part. Examples of such groups: 2003, 2004, 2005.

YearAge

This option is in effect only for fields that store date/time values.

Field values are grouped by the number of full years that have elapsed till the current date. The lengths of groups is determined by the PivotGridField.GroupIntervalNumericRange property.

MonthAge

This option is in effect only for fields that store date/time values.

Field values are grouped by the number of full months that have elapsed till the current date. The lengths of groups is determined by the PivotGridField.GroupIntervalNumericRange property.

WeekAge

This option is in effect only for fields that store date/time values.

Field values are grouped by the number of full weeks that have elapsed till the current date. The lengths of groups is determined by the PivotGridField.GroupIntervalNumericRange property.

DayAge

This option is in effect only for fields that store date/time values.

Field values are grouped by the number of full days that have elapsed till the current date. The lengths of groups is determined by the PivotGridField.GroupIntervalNumericRange property.

Alphabetical

Combines field values into categories according to the character that the values start with.

Numeric

This option is in effect only for fields that store numeric values.

Field values are grouped into intervals as defined by the PivotGridField.GroupIntervalNumericRange property.

Hour

This option is in effect only for fields that store date/time values.

Field values are grouped by the hour part, regardless of the date to which the current date/time value belongs.

Custom

Enables combining the field's data into custom intervals via the PivotGridControl.CustomGroupInterval event.

Not supported in OLAP mode.

Minute

This option is in effect only for fields that store date/time values.

Field values are grouped by the minute part, regardless of the date to which the current date/time value belongs.

Second

This option is in effect only for fields that store date/time values.

Field values are grouped by the second part, regardless of the date to which the current date/time value belongs.

DateMonthYear

This option is in effect only for fields that store date/time values.

Field values are grouped by the date part. Examples of groups: 3/4/2012, 3/5/2012, 3/6/2012, ...

DateQuarterYear

This option is in effect only for fields that store date/time values.

Field values are grouped by the year and quarter. Examples of groups: Q3 2012, Q4 2012, Q1 2013, Q2 2013, ...

DateHour

This option is in effect only for fields that store date/time values.

Field values are grouped by the date part with the hour value. Examples of such groups: 3/4/2012 0:00, 3/4/2012 1:00, 3/4/2012 2:00, ...

DateHourMinute

This option is in effect only for fields that store date/time values.

Field values are grouped by the date part with the hour and minute values. Examples of groups: 3/4/2012 0:00, 3/4/2012 0:01, 3/4/2012 0:02, ...

DateHourMinuteSecond

This option is in effect only for fields that store date/time values.

Field values are grouped by the date part with the hour, minute and second values. Examples of groups: 3/4/2012 0:00:00, 3/4/2012 0:00:01, 3/4/2012 0:00:02, ...

Passed To

You can pass FieldGroupInterval values to the following properies:

Remarks

For column and row fields values can be grouped. By default, the PivotGrid control doesn't group the values of these fields and displays all their unique values along its left and top edge. The PivotGridField.GroupInterval property of the FieldGroupInterval class allows you to change the logic used to decide which values should be grouped together.

Grouping field values is normally most useful for fields that store date/time values. It's possible to group these values by the year, month, date, quarter, etc.

Note that you can bind multiple PivotGridField objects to the same field in the underlying data source. These fields can have different values for their PivotGridField.GroupInterval property. In this instance, each such field will group the same data in its own way.

See Also