Totals

  • 4 minutes to read

The PivotGridControl calculates summary values (totals) and displays them as additional columns or rows. The following types of totals are supported:

Automatic Totals

  • The automatic totals can be divided into two types:

 

  • Row/column totals display sub-totals calculated for outer row/column fields.
  • Row/column grand totals display summary totals calculated against all the rows/columns.

CD_Totals_Automatic

The automatic totals are calculated using a summary function the corresponding data field specifies.

You can access the totals and grand totals settings using the PivotGridControl.OptionsView property. The table below lists the common members that configure automatic totals:

Member Description
PivotGridFieldOptions.ShowTotals Gets or sets whether Totals that correspond to the current data field are visible.
PivotGridOptionsViewBase.ShowRowTotals Gets or sets whether to display row automatic Totals.
PivotGridOptionsViewBase.ShowColumnTotals Gets or sets whether to display column automatic Totals.
PivotGridOptionsViewBase.ColumnTotalsLocation Gets or sets the column totals' location.
PivotGridOptionsViewBase.RowTotalsLocation Gets or sets the totals' and grand totals' location.
PivotGridOptionsViewBase.ShowColumnGrandTotals Gets or sets whether to display column Grand Totals.
PivotGridOptionsViewBase.ShowRowGrandTotals Gets or sets whether to display row Grand Totals.
PivotGridOptionsViewBase.ShowTotalsForSingleValues Gets or sets whether automatic totals are displayed for the field values which contain a single nesting field value.
PivotGridOptionsViewBase.ShowGrandTotalsForSingleValues Gets or sets whether grand totals are displayed when the control lists a single value of an outer column field or row field along its left or top edge.
NOTE

See the PivotGridOptionsViewBase class members to get a full list of members you can use to configure totals.

Use custom totals to calculate totals using a different summary function, or to calculate multiple subtotals.

Custom Totals

You may need to manually specify how many and what type of totals to display for each field. The custom totals replace automatic totals and can be calculated using various aggregation functions like Sum, Min, Max, Average, etc. The number of totals depends on how many items you add to the field's custom total collection.

For example, the image below shows the Category Name field displaying Sum and Max totals:

CD_Totals_CustomTotals_CustomTotals

The sample code below allows you to create the same layout as the image above:


using DevExpress.Data.PivotGrid;
using DevExpress.XtraPivotGrid;

// Gets a reference to the CategoryName field.
PivotGridField field = pivotGridControl1.Fields["CategoryName"];
pivotGridControl1.BeginUpdate();
try {
   // Clears the custom total collection.
   field.CustomTotals.Clear();
   // Adds items to the custom total collection with 
   // the specified summary types.
   field.CustomTotals.Add(PivotSummaryType.Sum);
   field.CustomTotals.Add(PivotSummaryType.Max);
   // Makes the custom totals visible for this field.
   field.TotalsVisibility = PivotTotalsVisibility.CustomTotals; 
}
finally {
   pivotGridControl1.EndUpdate();
}

The following table lists the members you can use to configure custom totals:

Member Description
PivotGridFieldBase.TotalsVisibility Gets or sets whether to display totals for the current field when it is in the Column Header Area or Row Header Area and if so, whether they are automatic or custom.
PivotGridField.CustomTotals Gets the current field's custom total collection.
PivotGridCustomTotalBase.SummaryType Gets or sets the type of the summary function used to calculate the current custom total.
PivotGridOptionsViewBase.ShowCustomTotalsForSingleValues Gets or sets whether custom totals are displayed for the field values which contain a single nesting field value.

Running Totals

Running totals allow you to calculate cumulative values that correspond to the specified column or row fields. For instance, in the PivotGridControl below, running totals are enabled for the Quarter field:

RunningTotals_Property

In the result, the PivotGrid control in the image below displays cumulative sales for each quarter over a two-year period:

RunningTotals_CrossGroupTrue

Note that cumulative values depend on the values' order. End-users can change the order by sorting, grouping or filtering.

You can specify whether running totals are calculated independently within individual groups, or for the entire PivotGrid. In the image below, running totals for the Quarter field are calculated independently for each year (cross-group variation is disabled):

RunningTotals_CrossGroupFalse

The table below lists the members you can use to configure running totals:

Member Description
PivotGridFieldBase.RunningTotal Gets or sets whether Running totals are calculated for values in the Data Area that correspond to the current column or row field.
PivotGridOptionsData.AllowCrossGroupVariation Gets or sets whether summary variations and running totals are calculated independently within individual groups, or throughout the Pivot Grid.
See Also