ScaleGridOptionsBase.AggregateFunction Property

Gets or sets the value indicating the aggregate function that should be used to relieve data.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public AggregateFunction AggregateFunction { get; set; }

VB.NET

Public Property AggregateFunction As AggregateFunction

Property Value

Type	Description
AggregateFunction	The value indicating the aggregate function that should be used to relieve data.

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.
Sum	Aggregates data by calculating the summary 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.
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 open value of the first data point and the close value equals the close value of the last data point.
Custom	Aggregates data using the custom CustomAggregateFunction calculator.

Related GitHub Examples

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

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-use-automatic-date-time-scale-modes-of-an-axis-e1531/CS/DateTimeAggregation/Form1.cs#L147

void SetAxisXAggregateFunction(AggregateFunction aggregateFunction) {
    AxisX.DateTimeScaleOptions.AggregateFunction = aggregateFunction;
}

winforms-chart-draw-a-custom-series-marker-in-the-crosshair/CS/CustomDrawCrosshairSample/Form1.cs#L47

if (diagram != null) {
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Sum;
    diagram.AxisX.DateTimeScaleOptions.MeasureUnit = DateTimeMeasureUnit.Year;

winforms-chart-draw-a-custom-legend-marker-for-a-series/CS/CustomDrawingSample/Form1.cs#L49

if (diagram != null) {
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Sum;
    diagram.AxisX.DateTimeScaleOptions.MeasureUnit = DateTimeMeasureUnit.Year;

webchartcontrol-how-to-create-a-drill-down-chart/CS/DrillDownChart/WebForm1.aspx.cs#L29

    diagram.AxisX.DateTimeScaleOptions.ScaleMode = ScaleMode.Automatic;
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Sum;
}

VB.NET

how-to-use-automatic-date-time-scale-modes-of-an-axis-e1531/VB/DateTimeAggregation/Form1.vb#L153

Private Sub SetAxisXAggregateFunction(ByVal aggregateFunction As AggregateFunction)
    AxisX.DateTimeScaleOptions.AggregateFunction = aggregateFunction
End Sub

winforms-chart-draw-a-custom-series-marker-in-the-crosshair/VB/CustomDrawCrosshairSample/Form1.vb#L52

If diagram IsNot Nothing Then
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Sum
    diagram.AxisX.DateTimeScaleOptions.MeasureUnit = DateTimeMeasureUnit.Year

winforms-chart-draw-a-custom-legend-marker-for-a-series/VB/CustomDrawingSample/Form1.vb#L53

If diagram IsNot Nothing Then
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Sum
    diagram.AxisX.DateTimeScaleOptions.MeasureUnit = DateTimeMeasureUnit.Year

webchartcontrol-how-to-create-a-drill-down-chart/VB/DrillDownChart/WebForm1.aspx.vb#L30

    diagram.AxisX.DateTimeScaleOptions.ScaleMode = ScaleMode.Automatic
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Sum
End If