Back to Devexpress

Data Aggregation

wpf-16846-controls-and-libraries-charts-suite-chart-control-data-aggregation.md

latest24.2 KB
Original Source

Data Aggregation

  • May 28, 2021
  • 8 minutes to read

The Chart Control can use an aggregate function to group raw data source values and show aggregates as series points. You can use aggregation to show grouped data and decrease the number of visible points in a chart. Data aggregation is only available for argument axes (x-axes).

Note

25.2 Demo Center: Launch the Data Aggregation demo

Aggregation vs Summaries

In addition to Aggregation , the Chart Control provides Summaries that also allow you to group raw data values.

AggregationSummary
Store DataChart stores raw data source values.Chart stores summarized values.
Change Detail LevelChart re-calculates data in memory.Chart re-loads data from the data source.
Behave on ZoomIf the automatic scale options are used, Chart recalculates value aggregates when it is zoomed.Chart does not re-calculate aggregated values when it is zoomed.
Memory ConsumptionHighLow

Aggregation Basics

When the aggregation is enabled, the chart splits the x-axis into intervals (the x-axis measurement unit value defines the intervals), and uses an aggregate function to aggregate data for each interval.

The AggregateFunction enumeration lists the available aggregate functions:

  • Average (a default function)
  • Count
  • Financial (Use it for financial series.)
  • Histogram (See the Histogram topic for more information.)
  • Maximum
  • Minimum
  • Sum
  • Custom (Refer to the Create an Aggregate Function section for more information.)

Scale options assigned to the x-axis’s ~ ScaleOptions property store aggregation-related settings. You can use the following option types:

|

Options

|

Description

|

How to use

| | --- | --- | --- | |

Automatic Date-Time , Automatic Time-Span , and Automatic Numeric

|

The chart control defines the optimal measurement unit for an axis based on the data set’s values, the Chart Control’s current size, and zoom level.

|

For date-time axes. Assign a AutomaticDateTimeScaleOptions object to the AxisX2D.DateTimeScaleOptions, AxisX3D.DateTimeScaleOptions or RadarAxisX2D.DateTimeScaleOptions property.
For time-span axes. Assign a AutomaticTimeSpanScaleOptions object to the AxisX2D.TimeSpanScaleOptions, AxisX3D.TimeSpanScaleOptions or RadarAxisX2D.TimeSpanScaleOptions property.
For numeric axes. Assign a AutomaticNumericScaleOptions object to the AxisX2D.NumericScaleOptions, AxisX3D.NumericScaleOptions or CircularAxisX2D.NumericScaleOptions property.

| |

Manual Date-Time , Manual Time-Span , and Manual Numeric

|

You can use the MeasureUnit property to specify the axis measurement unit that defines how to divide an axis scale into intervals for aggregation.

|

For date-time axes. Assign a ManualDateTimeScaleOptions (or its descendant) object to the AxisX2D.DateTimeScaleOptions, AxisX3D.DateTimeScaleOptions or RadarAxisX2D.DateTimeScaleOptions property.
For time-span axes. Assign a ManualTimeSpanScaleOptions (or its descendant) object to the AxisX2D.TimeSpanScaleOptions, AxisX3D.TimeSpanScaleOptions or RadarAxisX2D.TimeSpanScaleOptions property.
For numeric axes. Assign a ManualNumericScaleOptions (or its descendant) object to the AxisX2D.NumericScaleOptions, AxisX3D.NumericScaleOptions or CircularAxisX2D.NumericScaleOptions property.

| |

Qualitative

|

Chart aggregates point values if points have equal arguments.

|

For qualitative axes. Assign QualitativeScaleOptions to the AxisX2D.QualitativeScaleOptions or AxisX3D.QualitativeScaleOptions property.

|

Note

Axes that have the Continuous scale type (ContinuousDateTimeScaleOptions, ContinuousTimeSpanScaleOptions and ContinuousNumericScaleOptions) do not support aggregation.

Aggregate Date-Time Data

The following images show aggregated date-time data:

MeasureUnit = “Year”; GridAlignment = “Year”

MeasureUnit = “Month”; GridAlignment = “Year”

MeasureUnit = “Month”; GridAlignment = “Month”

The examples below use an Average function to aggregate date-time data:

Automatic Mode

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.DateTimeScaleOptions>
                <dxc:AutomaticDateTimeScaleOptions AggregateFunction="Average"/>
            </dxc:AxisX2D.DateTimeScaleOptions>                    
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
    <!--...-->
</dxc:XYDiagram2D>

Manual Mode

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.DateTimeScaleOptions>
                <dxc:ManualDateTimeScaleOptions AggregateFunction="Average" 
                                                MeasureUnit="Year" 
                                                GridAlignment="Year"/>      
            </dxc:AxisX2D.DateTimeScaleOptions>        
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
    <!--...-->
</dxc:XYDiagram2D>

The examples above use the following API members:

MemberDescription
AxisX2D.DateTimeScaleOptionsProvides access to the options that define the behavior of a date-time X-scale when its mode is manual, automatic or continuous.
AutomaticDateTimeScaleOptionsContains settings for a date-time axis data when its scale mode is automatic.
ManualDateTimeScaleOptionsContains settings for a date-time axis data when its scale mode is manual.

See also the following examples:

Form a Custom Measurement Unit

You can use the ManualDateTimeScaleOptions.MeasureUnit property with the ManualDateTimeScaleOptions.MeasureUnitMultiplier property to configure a custom measurement unit for time-span axes with a manual scale.

For instance, set the MeasureUnit to Month and the MeasureUnitMultiplier to 6 to specify a measurement unit of six months.

MeasureUnit = Month; MeasureUnitMultiplier = 1

MeasureUnit = Month; MeasureUnitMultiplier = 6

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.DateTimeScaleOptions>
                <dxc:ManualDateTimeScaleOptions AggregateFunction="Average" 
                                                GridAlignment="Year" 
                                                MeasureUnit="Month" 
                                                MeasureUnitMultiplier="6"/>
            </dxc:AxisX2D.DateTimeScaleOptions>                    
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
</dxc:XYDiagram2D>

Aggregate Time-Span Data

The following images show non-aggregated and aggregated time-span data:

MeasureUnit = “Minute”; AggregateFunction = “None”

MeasureUnit = “Hour”; AggregateFunction = “None”

MeasureUnit = “Hour”; AggregateFunction = “Average”

The examples below use an Average function to aggregate time-span data:

Automatic Mode

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.TimeSpanScaleOptions>
                <dxc:AutomaticTimeSpanScaleOptions AggregateFunction="Average"/>
            </dxc:AxisX2D.TimeSpanScaleOptions>                    
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
</dxc:XYDiagram2D>

Manual Mode

xaml
<dxc:XYDiagram2D>    
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.TimeSpanScaleOptions>
                <dxc:ManualTimeSpanScaleOptions MeasureUnit="Hour" 
                                                AggregateFunction="Average"/>
            </dxc:AxisX2D.TimeSpanScaleOptions>                     
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
</dxc:XYDiagram2D>

The examples above use the following API members:

MemberDescription
AxisX2D.TimeSpanScaleOptionsGets or sets options of the time-span scale used by the argument axis.
AutomaticTimeSpanScaleOptionsContains scale settings for an axis when its scale mode is automatic.
ManualTimeSpanScaleOptionsContains settings for a time-span axis when its scale mode is manual. This scale mode allows you to specify a measurement unit.

Form a Custom Measurement Unit

You can use the ManualTimeSpanScaleOptions.MeasureUnit property with the ManualTimeSpanScaleOptions.MeasureUnitMultiplier property to configure a custom measurement unit for time-span axes with a manual scale.

For instance, set the MeasureUnit to Hour and the MeasureUnitMultiplier to 3 to specify a measurement unit of three hours.

MeasureUnit = Hour; MeasureUnitMultiplier = 3

MeasureUnit = Hour; MeasureUnitMultiplier = 6

xaml
<dxc:XYDiagram2D.AxisX>
    <dxc:AxisX2D GridLinesVisible="False">
        <dxc:AxisX2D.TimeSpanScaleOptions>
            <dxc:ManualTimeSpanScaleOptions AutoGrid="False" AggregateFunction="Average"
                                            MeasureUnit="Hour" MeasureUnitMultiplier="3"
                                            GridSpacing="3" GridAlignment="Hour"/>
        </dxc:AxisX2D.TimeSpanScaleOptions>
    </dxc:AxisX2D>
</dxc:XYDiagram2D.AxisX>

Aggregate Numeric Data

The following images show aggregated numeric data:

AggregationFunction = “Average”; MeasureUnit = “10000”

AggregationFunction = “Average”; MeasureUnit = “1000”

The examples below use an Average function to aggregate numeric data:

Automatic Mode

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.NumericScaleOptions>
                <dxc:AutomaticNumericScaleOptions AggregateFunction="Average"/>
            </dxc:AxisX2D.NumericScaleOptions>
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
</dxc:XYDiagram2D>

Manual Mode

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.NumericScaleOptions>
                <dxc:ManualNumericScaleOptions AggregateFunction="Average" 
                                               MeasureUnit="1000"/>       
            </dxc:AxisX2D.NumericScaleOptions>
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
</dxc:XYDiagram2D>

The examples above use the following API members:

MemberDescription
AxisX2D.NumericScaleOptionsProvides access to the options that define the behavior of a numeric X-scale when its mode is manual, automatic or continuous.
AutomaticNumericScaleOptionsContains settings for a numeric axis data when its scale mode is automatic.
ManualNumericScaleOptionsContains settings for a numeric axis data when its scale mode is manual.

See also the following examples:

Aggregate Qualitative Data

The following images show non-aggregated and aggregated qualitative data:

AggregationFunction = “None”

AggregationFunction = “Average”

AggregationFunction = “Sum”

The example below uses a Sum function to aggregate qualitative data:

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.QualitativeScaleOptions>
                <dxc:QualitativeScaleOptions AggregateFunction="Sum"/>
            </dxc:AxisX2D.QualitativeScaleOptions>
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>   
</dxc:XYDiagram2D>

Aggregate an Individual Series’s Data

You can apply different aggregate functions to series that are bound to the same x-axis. In this case, the aggregate function applied to a series has higher priority than the axis’s aggregate function. To specify a series’s aggregate function, use the XYSeries.AggregateFunction property.

The following example uses the Financial function to aggregate the Stock series and the Sum function - the Bar series:

xaml
<dxc:XYDiagram2D>
    <dxc:StockSeries2D
        x:Name="stockSeries"
        DisplayName="Price"
        ArgumentDataMember="DateTimeStamp"
        OpenValueDataMember="Open"
        HighValueDataMember="High"
        LowValueDataMember="Low"
        CloseValueDataMember="Close"
        AggregateFunction="Financial">
    </dxc:StockSeries2D>
    <dxc:BarSideBySideSeries2D
        x:Name="volumeSeries"
        DisplayName="Volume"
        ArgumentDataMember="DateTimeStamp"
        ValueDataMember="Volume"
        AggregateFunction="Sum">
    </dxc:BarSideBySideSeries2D>
</dxc:XYDiagram2D>

Create a Custom Aggregate Function

The example below shows how to implement an aggregate function:

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.AxisX>
        <dxc:AxisX2D>
            <dxc:AxisX2D.DateTimeScaleOptions>
                <dxc:AutomaticDateTimeScaleOptions AggregateFunction="Custom">
                    <dxc:AutomaticDateTimeScaleOptions.CustomAggregateFunction>
                        <local:StandardDeviationAggregateFunction/>
                    </dxc:AutomaticDateTimeScaleOptions.CustomAggregateFunction>
                </dxc:AutomaticDateTimeScaleOptions>
            </dxc:AxisX2D.DateTimeScaleOptions>
            <!--...-->                      
        </dxc:AxisX2D>
    </dxc:XYDiagram2D.AxisX>
    <!--...-->
</dxc:XYDiagram2D>
csharp
using DevExpress.Xpf.Charts;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Windows;
using System.Xml.Linq;

namespace DateTimeAggregation {
    class StandardDeviationAggregateFunction : CustomAggregateFunction {
        public override string ToString() {
            return "StdDev (Custom)";
        }
        public override double[] Calculate(GroupInfo groupInfo) {
            double sum = 0.0;
            foreach(double value in groupInfo.Values1) {
                sum += value;
            }
            int len = groupInfo.Values1.Count();
            double averageAmount = sum / len;
            double standardDeviationSquareSum = 0.0;
            foreach(double value in groupInfo.Values1) {
                double deviation = value - averageAmount;
                standardDeviationSquareSum += deviation * deviation;
            }
            double stdDev = Math.Sqrt(standardDeviationSquareSum / len);
            return new double[1] { stdDev };
        }
    }
}
vb
Imports DevExpress.Xpf.Charts
Imports System
Imports System.Collections.Generic
Imports System.Globalization
Imports System.IO
Imports System.Linq
Imports System.Windows
Imports System.Xml.Linq

Namespace DateTimeAggregation
    Class StandardDeviationAggregateFunction
        Inherits CustomAggregateFunction

        Public Overrides Function ToString() As String
            Return "StdDev (Custom)"
        End Function

        Public Overrides Function Calculate(ByVal groupInfo As GroupInfo) As Double()
            Dim sum As Double = 0.0

            For Each value As Double In groupInfo.Values1
                sum += value
            Next

            Dim len As Integer = groupInfo.Values1.Count()
            Dim averageAmount As Double = sum / len
            Dim standardDeviationSquareSum As Double = 0.0

            For Each value As Double In groupInfo.Values1
                Dim deviation As Double = value - averageAmount
                standardDeviationSquareSum += deviation * deviation
            Next

            Dim stdDev As Double = Math.Sqrt(standardDeviationSquareSum / len)
            Return New Double(0) {stdDev}
        End Function
    End Class
End Namespace