PivotGridField.SummaryDisplayType Property

Gets or sets how a summary value calculated against the current data field is represented in a cell. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public FieldSummaryDisplayType SummaryDisplayType { get; set; }

VB.NET

Public Property SummaryDisplayType As FieldSummaryDisplayType

Property Value

Type	Description
FieldSummaryDisplayType	A FieldSummaryDisplayType enumeration member that specifies how summary values are represented within cells.

Available values:

Show 13 items

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

For each cell, the DXPivotGrid calculates a summary against a corresponding data field. The summary type is determined by the PivotGridField.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.CustomCellDisplayText or PivotGridControl.CustomSummary event. To specify the formatting settings use the data field’s PivotGridField.CellFormat property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

XAML

how-to-define-a-custom-cell-template-that-allows-performing-data-editing-t410760/CS/HowToEditCell/MainWindow.xaml#L75

        Name="fieldExtendedPrice2"
        SummaryDisplayType="PercentOfColumn" />
</dxpg:PivotGridControl.Fields>