AutomaticNumericScaleOptions.AggregateFunction Property

Gets or sets the function that is used to aggregate numeric axis data when one of the AxisX2D.NumericScaleOptions, AxisX3D.NumericScaleOptions, or CircularAxisX2D.NumericScaleOptions properties is set to AutomaticNumericScaleOptions.

Namespace: DevExpress.Xpf.Charts

Assembly: DevExpress.Xpf.Charts.v24.1.dll

NuGet Package: DevExpress.Wpf.Charts

Declaration

C#

public AggregateFunction AggregateFunction { get; set; }

VB.NET

Public Property AggregateFunction As AggregateFunction

Property Value

Type	Description
AggregateFunction	An AggregateFunction enumeration value.

Available values:

Name	Description
None	The aggregate function is not applied.
Average	Aggregates data by calculating the average value for a selected numeric or date-time interval.
Minimum	Aggregates data by calculating the minimum value for a selected numeric or date-time interval.
Maximum	Aggregates data by calculating the maximum value for a selected numeric or date-time interval.
Sum	Aggregates data by calculating the summary for a selected numeric or date-time interval.
Count	Aggregates data by calculating the number of non-null values for a selected numeric or date-time interval.
Histogram	Aggregates data by calculating the number of all points for a selected numeric or date-time interval.
Financial	Aggregates financial data for a selected interval into a single high-low-open-close data point, so that the high value equals the highest value of all data points in this interval; the low value equals the lowest value of all data points; the open value equals the value of the first data point and the close value equals the value of the last data point.
Custom	Aggregates data using the custom CustomAggregateFunction calculator.

Remarks

The image below shows numeric data aggregation in the Automatic scale mode using the default Average function.

Note

The AggregateFunction property is set to AggregateFunction.Average by default.

To disable numeric data aggregation, set the AggregateFunction property to AggregateFunction.None.

To learn more, see Data Aggregation.

Example

This code snippet shows how to access the automatic numeric scale options for the X-axis scale and specify the aggregate function. The automatic options allow the chart control to automatically define the optimal unit of measure for an axis based on the input data, and the zoom level.

XAML

<Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxc="http://schemas.devexpress.com/winfx/2008/xaml/charts" 
        x:Class="WpfApplication19.MainWindow"
        Title="MainWindow" Height="350" Width="525">
    <Grid>

        <dxc:ChartControl>
            <dxc:XYDiagram2D>
                <dxc:XYDiagram2D.AxisX>
                    <dxc:AxisX2D>
                        <dxc:AxisX2D.NumericScaleOptions>
                            <dxc:AutomaticNumericScaleOptions AggregateFunction="Maximum" />
                        </dxc:AxisX2D.NumericScaleOptions>
                    </dxc:AxisX2D>
                </dxc:XYDiagram2D.AxisX>              
            </dxc:XYDiagram2D>          
        </dxc:ChartControl>
    </Grid>
</Window>