PivotGridField.GroupInterval Property

Gets or sets how the values of the current column or row field are combined into groups. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v24.1.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public FieldGroupInterval GroupInterval { get; set; }

VB.NET

Public Property GroupInterval As FieldGroupInterval

Property Value

Type	Description
FieldGroupInterval	A FieldGroupInterval value that specifies how the values of the current field are combined into groups.

Available values:

Show 26 items

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, …
DateWeekYear	This option is in effect only for fields that store date/time values. Field values are grouped by the date of the first day of the week (uses culture settings). Examples of such groups: 7/1/2018, 7/8/2018, 7/15/2018.

Remarks

Values of column and 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 left and top edge. The GroupInterval property allows you to change the logic used to decide which values should be grouped together.

For instance, for a field which displays date/time values, you can set its GroupInterval property to FieldGroupInterval.DateYear. As a result, the field’s values will be grouped within a few categories, each of which will combine different values that belong to the same year.

To learn more, see Grouping.

Example

This example shows how to group date-time values.

View Example

MainWindow.xaml

<Window x:Class="HowToBindToMDB.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        Title="MainWindow" Height="350" Width="525"  Loaded="Window_Loaded">
    <Grid>
        <dxpg:PivotGridControl Name="pivotGridControl1" DataProcessingEngine="Optimized">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldYear" Area="RowArea" Caption="Year">
                    <dxpg:PivotGridField.DataBinding>
                        <dxpg:DataSourceColumnBinding ColumnName="OrderDate" GroupInterval="DateYear"/>
                    </dxpg:PivotGridField.DataBinding>
                </dxpg:PivotGridField>
                <dxpg:PivotGridField Name="fieldQuarter" Area="RowArea" Caption="Quarter"
                                     ValueFormat="Qtr {0}" >
                    <dxpg:PivotGridField.DataBinding>
                        <dxpg:DataSourceColumnBinding ColumnName="OrderDate" GroupInterval="DateQuarter"/>
                    </dxpg:PivotGridField.DataBinding>
                </dxpg:PivotGridField>
                <dxpg:PivotGridField Name="fieldMonth" Area="RowArea" Caption="Month" >
                    <dxpg:PivotGridField.DataBinding>
                        <dxpg:DataSourceColumnBinding ColumnName="OrderDate" GroupInterval="DateMonth"/>
                    </dxpg:PivotGridField.DataBinding>
                </dxpg:PivotGridField>
                <dxpg:PivotGridField Name="fieldExtendedPrice" Area="DataArea" CellFormat="c0" >
                    <dxpg:PivotGridField.DataBinding>
                        <dxpg:DataSourceColumnBinding ColumnName="Extended Price"/>
                    </dxpg:PivotGridField.DataBinding>
                </dxpg:PivotGridField>
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GroupInterval property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-pivotgrid-customize-filter-drop-down/CS/WpfPivotCustomFilterDropDownExample/MainWindow.xaml#L56

FieldName="OrderDate"
GroupInterval="Date"
Name="fieldOrderDate"

wpf-pivot-grid-add-custom-field-values-rows-columns-not-present-in-datasource/CS/WpfApplication1/MainWindow.xaml#L15

<dxpg:PivotGridField Area="DataArea" Caption="Value" FieldName="Value"/>
<dxpg:PivotGridField Area="ColumnArea" Caption="Year" FieldName="Date" GroupInterval="DateYear"/>
<dxpg:PivotGridField Area="ColumnArea" Caption="Quarter" FieldName="Date" GroupInterval="DateQuarter"/>

wpf-pivotgrid-how-to-display-underlying-data/CS/WpfDrillDownDataSourceExample/MainWindow.xaml#L42

    FieldName="OrderDate"
    GroupInterval="Date" />
<dxpg:PivotGridField

wpf-pivot-grid-apply-format-conditions-to-data-cells/CS/WpfPivotGridConditionalFormatting/MainWindow.xaml#L68

<dxpg:PivotGridField Area="ColumnArea" Caption="Year" FieldName="OrderDate"
                     Name="fieldYear" GroupInterval="DateYear" AreaIndex="0" />
<dxpg:PivotGridField Area="ColumnArea" Caption="Quarter" FieldName="OrderDate"

wpf-pivotgrid-customize-the-cell-template/CS/HowToCustomizeCellTemplate/MainWindow.xaml#L22

    FieldName="OrderDate"
    GroupInterval="DateYear" />
<dxpg:PivotGridField

VB.NET

wpf-pivot-grid-connect-to-an-access-database-in-code/VB/HowToBindToMDB/MainWindow.xaml.vb#L35

' Group field values by years.
fieldYear.GroupInterval = FieldGroupInterval.DateYear
' Create a column pivot grid field bound to the CategoryName datasource field.