Back to Devexpress

DateTimeSummaryOptions Class

corelibraries-devexpress-dot-xtracharts-d5a935c7.md

latest3.5 KB
Original Source

DateTimeSummaryOptions Class

Date-time summarization options storage.

Namespace : DevExpress.XtraCharts

Assembly : DevExpress.XtraCharts.v25.2.dll

NuGet Package : DevExpress.Charts

Declaration

csharp
public class DateTimeSummaryOptions :
    SummaryOptionsBase,
    IDateTimeSummaryOptions,
    ISummaryOptionsBase
vb
Public Class DateTimeSummaryOptions
    Inherits SummaryOptionsBase
    Implements IDateTimeSummaryOptions,
               ISummaryOptionsBase

The following members return DateTimeSummaryOptions objects:

Remarks

The SeriesBase.DateTimeSummaryOptions property has this type.

The series groups values with more detailed argument values into a collection with the key that has the required precision value. Then, the summary function calculates series points’ values by these collections.

Note that the options’ DateTimeSummaryOptions.MeasureUnit specifies the most data detail level. And, any options change leads to data reload. Use the AxisBase.DateTimeScaleOptions to display less detail data without data reload.

Example

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

csharp
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
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

Inheritance

Object ChartElement SummaryOptionsBase DateTimeSummaryOptions

See Also

DateTimeSummaryOptions Members

DevExpress.XtraCharts Namespace