PivotGridFieldBase.SummaryDisplayType Property
Gets or sets how a summary value calculated against the current data field is represented in a cell.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.PivotGrid.v24.1.Core.dll
NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation
Declaration
[PivotAPIMemberCategory(APICategory.NotSupportedInOptimizedMode)]
[XtraSerializableProperty(20)]
[XtraSerializablePropertyId(2)]
public PivotSummaryDisplayType SummaryDisplayType { get; set; }Property Value
| Type | Description |
|---|---|
| PivotSummaryDisplayType | A PivotSummaryDisplayType value that specifies how summary values are represented within cells. |
Available values:
| Name | Description |
|---|---|
| Default | The calculated summary values are displayed “as is”. |
| AbsoluteVariation | The absolute variance between the current value and the previously calculated value for the current field is displayed in the cell. |
| PercentVariation | The percentage variance between the current value and the previously calculated value for the current field is displayed in the cell. |
| PercentOfColumn | For data cells, the percentage of the column’s total value is displayed; for total cells, the percentage of the column’s grand total value is displayed. |
| PercentOfRow | For data cells, the percentage of the row’s total value is displayed; for total cells, the percentage of the row’s grand total value is displayed. |
| PercentOfColumnGrandTotal | Percent of the summary in the Column Grand Total value. |
| PercentOfRowGrandTotal | Percent of the summary in the Row Grand Total value. |
| PercentOfGrandTotal | Percent of the summary in the Grand Total value. |
| RankInColumnSmallestToLargest | The summary value’s rank in its column, with the smallest value in the column as 1, and each larger value assigned a higher rank. |
| RankInRowSmallestToLargest | The summary value’s rank in its row, with the smallest value in the row as 1, and each larger value assigned a higher rank. |
| RankInColumnLargestToSmallest | The summary value’s rank in its column, with the largest value in the column as 1, and each smaller value assigned a higher rank. |
| RankInRowLargestToSmallest | The summary value’s rank in its row, with the largest value in the row as 1, and each smaller value assigned a higher rank. |
| Index | An index value that reflects the summary value’s importance in its row and column context. This value is calculated as follows: ((value in cell) x (Grand Total of Grand Totals)) / ((Grand Row Total) x (Grand Column Total)) |
Remarks
Note
This member is not supported in Optimized, OLAP, and Server modes. Use Window Calculations for Optimized mode instead.
For each cell, the XtraPivotGrid calculates a summary against a corresponding data field. The summary type is determined by the PivotGridFieldBase.SummaryType property. The SummaryDisplayType property specifies how the calculated summary value is represented within cells (“as is”, or adjusted using a specific predefined algorithm). See Summary Display Modes for more details.
To implement custom summaries, handle the PivotGridControl.CustomCellValue or PivotGridControl.CustomSummary event. To specify the formatting settings use the data field’s PivotGridFieldBase.CellFormat property.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the SummaryDisplayType 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.