SummaryOptionsBase.SummaryFunction Property

Gets or sets the summary function that calculates the series points’ total value.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Data)]
[XtraSerializableProperty]
public string SummaryFunction { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Data)>
<XtraSerializableProperty>
Public Property SummaryFunction As String

Property Value

Type	Description
String	The string that defines the summary function that calculates the series points’ total value.

Property Paths

You can access this nested property as listed below:

Object Type	Path to SummaryFunction
Series	.QualitativeSummaryOptions.SummaryFunction
SeriesBase	.QualitativeSummaryOptions.SummaryFunction
SeriesTemplate	.QualitativeSummaryOptions.SummaryFunction

Remarks

The chart control provides the following built-in summary functions:

• minimum (“MIN([Field_name])”);
• maximum (“MAX([Field_name])”);
• sum (“SUM([Field_name])”);
• average (“AVERAGE([Field_name])”);
• count (“COUNT”).

Example

This example demonstrates how to use the summary options to configure the date-time data source summarization:

C#

List<SaleItem> dataSource = this.viewModel.GetSaleItems();
this.chartControl.DataSource = dataSource;
SeriesTemplate template = this.chartControl.SeriesTemplate;
template.SeriesDataMember = "Category";
template.ArgumentDataMember = "Company";
template.DateTimeSummaryOptions.MeasureUnit = DateTimeMeasureUnit.Month;
template.DateTimeSummaryOptions.SummaryFunction = "SUM([Income])";
template.View = new StackedBarSeriesView();

VB.NET

Dim dataSource As List<SaleItem> = Me.ViewModel.GetSaleItems()
Me.ChartControl.DataSource = dataSource
With Me.chartControl.SeriesTemplate
    .SeriesDataMember = "Category"
    .ArgumentDataMember = "Company"
    .DateTimeSummaryOptions.MeasureUnit = DateTimeMeasureUnit.Month
    .DateTimeSummaryOptions.SummaryFunction = "SUM([Income])"
    .View = new StackedBarSeriesView()
End With