ScaleGridOptionsBase.CustomAggregateFunction Property

Gets or sets the custom aggregate function callback that calculates the aggregated values.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v19.1.dll

Declaration

C#

[NonTestableProperty]
[Browsable(false)]
[XtraSerializableProperty(XtraSerializationVisibility.Hidden)]
public CustomAggregateFunction CustomAggregateFunction { get; set; }

VB.NET

<NonTestableProperty>
<Browsable(False)>
<XtraSerializableProperty(XtraSerializationVisibility.Hidden)>
Public Property CustomAggregateFunction As CustomAggregateFunction

Property Value

Type	Description
CustomAggregateFunction	The custom aggregate function callback.

Property Paths

You can access this nested property as listed below:

Show 24 property paths

Object Type	Path to CustomAggregateFunction
Axis	.DateTimeScaleOptions.CustomAggregateFunction
Axis2D	.DateTimeScaleOptions.CustomAggregateFunction
Axis3D	.DateTimeScaleOptions.CustomAggregateFunction
AxisBase	.DateTimeScaleOptions.CustomAggregateFunction
AxisX	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
AxisX3D	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
AxisXBase	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
AxisY	.DateTimeScaleOptions.CustomAggregateFunction
AxisY3D	.DateTimeScaleOptions.CustomAggregateFunction
AxisYBase	.DateTimeScaleOptions.CustomAggregateFunction
GanttAxisX	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
PolarAxisX	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
RadarAxis	.DateTimeScaleOptions.CustomAggregateFunction
RadarAxisX	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
RadarAxisY	.DateTimeScaleOptions.CustomAggregateFunction
SecondaryAxisX	.DateTimeScaleOptions.QualitativeScaleOptions.CustomAggregateFunction
SecondaryAxisY	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramAxis	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramAxisX	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramAxisXBase	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramAxisY	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramAxisYBase	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramSecondaryAxisX	.DateTimeScaleOptions.CustomAggregateFunction
SwiftPlotDiagramSecondaryAxisY	.DateTimeScaleOptions.CustomAggregateFunction

Example

Set the CustomAggregateFunction class descendant object to the ScaleGridOptionsBase.CustomAggregateFunction property to use the custom aggregate function. Note that the ScaleGridOptionsBase.AggregateFunction property should be set to Custom.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-implement-a-custom-aggregate-function-t625114

Form1.cs

private void Form1_Load(object sender, EventArgs e) {
    Series series = chartControl.Series["Random Data"];
    series.DataSource = GenerateData(100_000);
    series.ArgumentDataMember = "Argument";
    series.ValueDataMembers.AddRange("Value", "Value", "Value", "Value");

    XYDiagram diagram = chartControl.Diagram as XYDiagram;
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Custom;
    diagram.AxisX.DateTimeScaleOptions.CustomAggregateFunction = new OhlcAggregateFunction();
}

class OhlcAggregateFunction : CustomAggregateFunction {
    public override double[] Calculate(GroupInfo groupInfo) {
        double open = groupInfo.Values1.First();
        double close = groupInfo.Values1.Last();
        double high = Double.MinValue;
        double low = Double.MaxValue;
        foreach (double value in groupInfo.Values1) {
            if (high < value) high = value;
            if (low > value) low = value;
        }

        return new double[] { high, low, open, close };
    }
}

Form1.vb

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    Dim series As Series = chartControl.Series("Random Data")
    series.DataSource = GenerateData(100_000)
    series.ArgumentDataMember = "Argument"
    series.ValueDataMembers.AddRange("Value", "Value", "Value", "Value")

    Dim diagram As XYDiagram = TryCast(chartControl.Diagram, XYDiagram)
    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Custom
    diagram.AxisX.DateTimeScaleOptions.CustomAggregateFunction = New OhlcAggregateFunction()
End Sub

Private Class OhlcAggregateFunction
    Inherits CustomAggregateFunction

    Public Overrides Function Calculate(ByVal groupInfo As GroupInfo) As Double()
        Dim open As Double = groupInfo.Values1.First()
        Dim close As Double = groupInfo.Values1.Last()
        Dim high As Double = Double.MinValue
        Dim low As Double = Double.MaxValue
        For Each value As Double In groupInfo.Values1
            If high < value Then
                high = value
            End If
            If low > value Then
                low = value
            End If
        Next value

        Return New Double() { high, low, open, close }
    End Function
End Class

Related GitHub Examples

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

winforms-charts-implement-custom-aggregate-function/CS/DataAggregation/Form1.cs#L40

    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Custom;
    diagram.AxisX.DateTimeScaleOptions.CustomAggregateFunction = new OhlcAggregateFunction();
}

VB.NET

winforms-charts-implement-custom-aggregate-function/VB/DataAggregation/Form1.vb#L45

    diagram.AxisX.DateTimeScaleOptions.AggregateFunction = AggregateFunction.Custom
    diagram.AxisX.DateTimeScaleOptions.CustomAggregateFunction = New OhlcAggregateFunction()
End Sub