PivotWindowDefinition Class

A window definition used to perform calculations within the PivotDashboardItem.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v22.1.Core.dll

Declaration

C#

public class PivotWindowDefinition :
    MeasureCalculationWindowDefinition

VB.NET

Public Class PivotWindowDefinition
    Inherits MeasureCalculationWindowDefinition

Remarks

A window definition is used to apply calculations to measure values. To specify a window, create and initialize the PivotWindowDefinition class and assign the resulting object to the Measure.WindowDefinition property.

The PivotWindowDefinition class allows you to specify the window for the Pivot dashboard item.

Important

The assignment of a PivotWindowDefinition instance to the MeasureDefinition.WindowDefinition property is required to perform window calculations.

Example

The code snippet adds a new measure to the Pivot dashboard item and specifies a window calculation to compute the difference between measure values across a window. The calculation is performed along columns of the Pivot dashboard item.

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
// ...
PivotDashboardItem pivotItem = dashboardViewer1.Dashboard.Items[pivotItemName] as PivotDashboardItem;
if (pivotItem != null)
{
    Measure extendedPrice = new Measure("Extended Price")
    {
        Name = "Diff",
        ShowGrandTotals = false
    };
    PivotWindowDefinition pivotWindowDefinition = new PivotWindowDefinition();
    pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns;
    extendedPrice.WindowDefinition = pivotWindowDefinition;
    extendedPrice.Calculation = new DifferenceCalculation() { DifferenceType = DifferenceType.Absolute };
    pivotItem.Values.Add(extendedPrice);
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
' ...
Dim pivotItem As PivotDashboardItem = TryCast(dashboardViewer1.Dashboard.Items(pivotItemName), PivotDashboardItem)
If pivotItem IsNot Nothing Then
    Dim extendedPrice As New Measure("Extended Price") With { _
        .Name = "Diff", _
        .ShowGrandTotals = False _
    }
    Dim pivotWindowDefinition As New PivotWindowDefinition()
    pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns
    extendedPrice.WindowDefinition = pivotWindowDefinition
    extendedPrice.Calculation = New DifferenceCalculation() With {.DifferenceType = DifferenceType.Absolute}
    pivotItem.Values.Add(extendedPrice)
End If

Related GitHub Examples

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

winforms-dashboard-window-calculation-example/CS/WindowCalculationExample/Form1.cs#L44

};
PivotWindowDefinition pivotWindowDefinition = new PivotWindowDefinition();
pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns;

VB.NET

winforms-dashboard-window-calculation-example/VB/WindowCalculationExample/Form1.vb#L35

Dim extendedPrice As Measure = New Measure("Extended Price") With {.Name = "Diff", .ShowGrandTotals = False}
Dim pivotWindowDefinition As PivotWindowDefinition = New PivotWindowDefinition()
pivotWindowDefinition.DefinitionMode = PivotWindowDefinitionMode.Columns

Inheritance

Object

DevExpress.DashboardCommon.Native.ClonableModelBase<MeasureCalculationWindowDefinition>

MeasureCalculationWindowDefinition

PivotWindowDefinition