PivotSummaryDataSource Class

Represents a summary data source.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v17.2.Core.dll

Declaration

C#

public class PivotSummaryDataSource :
    PivotDataSource

VB.NET

Public Class PivotSummaryDataSource
    Inherits PivotDataSource

Related API Members

The following members accept/return PivotSummaryDataSource objects:

Library	Related API Members
Cross-Platform Class Library	PivotCellEventArgsBase<TField, TData, TCustomTotal>.CreateSummaryDataSource()
	PivotSummaryDataRow.DataSource
WinForms Controls	PivotCustomDrawCellBaseEventArgs.CreateSummaryDataSource()
	PivotGridControl.CreateSummaryDataSource()
ASP.NET Web Forms Controls	ASPxPivotGrid.CreateSummaryDataSource()
	ASPxPivotGrid.CreateSummaryDataSource(Int32, Int32)
	PivotGridExtension.CreateOLAPSummaryDataSource(PivotGridSettings, String)
	PivotGridExtension.CreateOLAPSummaryDataSource(PivotGridSettings, String, Int32, Int32)
	PivotGridExtension.CreateSummaryDataSource(PivotGridSettings, Object)
	PivotGridExtension.CreateSummaryDataSource(PivotGridSettings, Object, Int32, Int32)

Remarks

A summary data source can be represented by a table whose columns correspond to the fields, while the records correspond to the pivot grid data cells.

The summary data source can be created for all pivot grid cells (in this instance, use the PivotGridControl’s CreateSummaryDataSource method), or for individual cells when handling the cell events (in this instance, use the event parameter’s PivotGridCellBaseEventArgs.CreateSummaryDataSource method).

Note

Specific pivot grid controls (such as the ASPxPivotGrid) provide an overload of the CreateSummaryDataSource method, that allows you to create a summary data source for individual cells at any point.

The PivotSummaryDataSource class implements the IList interface, so the data returned by the CreateSummaryDataSource method can easily be displayed in a grid control. To bind a grid control to the summary data source, assign the PivotSummaryDataSource object to the grid’s DataSource property.

Individual records from the summary data source are represented by the PivotSummaryDataRow objects. The records are obtained using the indexed notation. The total number of records in the data source is returned by the PivotSummaryDataSource.RowCount property.

To obtain values of the data source cells, use the PivotSummaryDataSource.GetValue method.

Related GitHub Examples

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

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.

C#

how-to-implement-rank-function-in-xtrapivotgrid-e1474/CS/Form1.cs#L37

salesPerYear = new Dictionary<int, List<decimal>>();
PivotSummaryDataSource ds = pivotGridControl1.CreateSummaryDataSource();
for(int i = 0; i < ds.RowCount; i++) {

how-to-calculate-multiple-custom-totals-with-summarytype-set-to-custom-e3815/CS/XtraPivotGrid_MultipleCustomTotals/Form1.cs#L88

// Creates a summary data source.
PivotSummaryDataSource sds = e.CreateSummaryDataSource();

how-to-convert-pivotsummarydatasource-to-datatable-or-any-other-data-source-object-e2679/CS/WindowsApplication53/Form1.cs#L27

}
private DataTable ConvertPivotSummaryDataSourceToDataTable(PivotSummaryDataSource source)
{

how-to-represent-the-pivotgridcontrols-data-within-xtracharts-e549/CS/Form1.cs#L263

PivotSummaryDataSource ds = pivotGridControl1.CreateSummaryDataSource();

pivot-chart-integration-how-to-show-a-waterfall-chart-control-t155168/CS/WindowsApplication53/Form1.cs#L40

{
    PivotSummaryDataSource summaryDataSource = pivotGridControl1.CreateSummaryDataSource();

VB.NET

how-to-implement-rank-function-in-xtrapivotgrid-e1474/VB/Form1.vb#L39

salesPerYear = New Dictionary(Of Integer, List(Of Decimal))()
Dim ds As PivotSummaryDataSource = pivotGridControl1.CreateSummaryDataSource()
For i As Integer = 0 To ds.RowCount - 1

how-to-calculate-multiple-custom-totals-with-summarytype-set-to-custom-e3815/VB/XtraPivotGrid_MultipleCustomTotals/Form1.vb#L92

' Creates a summary data source.
Dim sds As PivotSummaryDataSource = e.CreateSummaryDataSource()

how-to-convert-pivotsummarydatasource-to-datatable-or-any-other-data-source-object-e2679/VB/WindowsApplication53/Form1.vb#L25

End Sub
Private Function ConvertPivotSummaryDataSourceToDataTable(ByVal source As PivotSummaryDataSource) As DataTable
    Dim dt As New DataTable()

how-to-represent-the-pivotgridcontrols-data-within-xtracharts-e549/VB/Form1.vb#L197

Dim ds As PivotSummaryDataSource = pivotGridControl1.CreateSummaryDataSource()

pivot-chart-integration-how-to-show-a-waterfall-chart-control-t155168/VB/WindowsApplication53/Form1.vb#L36

Private Function CreateIntermediateData(ByVal pivotgridControl As PivotGridControl) As DataTable
    Dim summaryDataSource As PivotSummaryDataSource = pivotGridControl1.CreateSummaryDataSource()

Inheritance

Object

PivotDataSource

PivotSummaryDataSource

PivotSummaryDataSource