Optimized Calculation Engine

• Oct 29, 2021
• 3 minutes to read

The PivotGridControl can operate in Optimized mode that uses the Optimized Calculation Engine. The Optimized Calculation engine boasts new functionality and improved performance, but does not support some legacy features.

New Functionality

• Intermediate Level Aggregations
• Window Calculations
• Data Binding API

Set the PivotGridOptionsData.DataProcessingEngine property to DataProcessingEngine.Optimized to switch to Optimized mode:

C#

pivotGridControl1.OptionsData.DataProcessingEngine = PivotDataProcessingEngine.Optimized;

VB.NET

pivotGridControl1.OptionsData.DataProcessingEngine = PivotDataProcessingEngine.Optimized

Intermediate Level Aggregations

Intermediate Level Aggregations use the summary function to calculate values for data obtained from the first specified data source column, group data by the next specified columns, and calculate group summaries. The aggr function can be nested and you can summarize aggregated data in an expression.

Tip

Documentation:

• Intermediate Level Aggregations

WinForms Pivot Grid Demo:

• Code Examples - Intermediate Level Aggregations (Optimized Mode) - Filter Sales by Year by country module in the XtraPivotGrid MainDemo
• Code Examples - Intermediate Level Aggregations (Optimized Mode) - Average sales by year module in the XtraPivotGrid MainDemo
• Code Examples - Intermediate Level Aggregations (Optimized Mode) - Grouping by year of first sale module in the XtraPivotGrid MainDemo

Window Calculations

Window calculations use window functions to calculate data across a set of window rows related to the current row. Partitioning criteria are applied to rows to arrange them in partitions (a subset of rows in a data table).

Tip

Documentation:

• Window Calculations Overview
• Partitioning Criteria
• Creating Window Calculations
• Window Calculation Functions

WinForms Pivot Grid Demo:

• Code Examples - Optimized Mode - Field Calculation Bindings module

Data Binding API

The key concept of the Data Binding API is the data binding source. The Data Binding API does not divide PivotGrid fields into bound and unbound. A field’s DataBinding property defines how the Pivot Grid field gets data. All functionality related to calculations are encapsulated into the data binding source — the DataBindingBase descendant that is assigned to the field’s DataBinding property.

The Data Binding API is in effect only in Optimized Mode. Other calculation engines ignore the DataBinding property.

Tip

Documentation:

• Data Binding API

Optimized Mode Restrictions

Note

Server mode is not supported when the Pivot Grid uses the Optimized calculation because this engine calculates data on the client side.

The following API are not supported in Optimized mode. The NotSupportedException occurs in Optimized mode for unavailable values, properties, and handled events.

Events

WinForms	WPF	ASP.NET
PivotGridControl.CustomSummary	PivotGridControl.CustomSummary	ASPxPivotGrid.CustomSummary
PivotGridControl.CustomGroupInterval	PivotGridControl.CustomGroupInterval	ASPxPivotGrid.CustomGroupInterval
PivotGridControl.CustomUnboundFieldData	PivotGridControl.CustomUnboundFieldData	ASPxPivotGrid.CustomUnboundFieldData
PivotGridControl.CustomFieldSort	PivotGridControl.CustomFieldSort	ASPxPivotGrid.CustomFieldSort

Use expressions, Aggr Functions, Window Functions instead the API listed above.

Properties

The following field’s properties are not supported:

WinForms	WPF	ASP.NET
UnboundFieldName	UnboundFieldName	UnboundFieldName
UnboundExpressionMode	UnboundExpressionMode	UnboundExpressionMode
ExpressionFieldName	ExpressionFieldName	ExpressionFieldName
FilterColumnName	FilterColumnName	FilterColumnName
PrefilterColumnName	PrefilterColumnName	PrefilterColumnName
RunningTotal	RunningTotal	RunningTotal
SummaryDisplayType	SummaryDisplayType	SummaryDisplayType

The following field’s properties are not supported when their value is set to Custom:

Property	Value
PivotGridField.SummaryType	PivotSummaryType.Custom
PivotGridField.GroupInterval	PivotGroupInterval.Custom
PivotGridField.SortMode	PivotSortMode.Custom

The field’s properties listed below are ignored when you use data binding API:

• UnboundExpression
• UnboundType
• FieldName
• GroupInterval
• GroupIntervalNumericRange

You can set the PivotGridFieldBase.DataBinding property to null to use them.