Back to Devexpress

SeriesTemplate.SeriesDataMember Property

corelibraries-devexpress-dot-xtracharts-dot-seriestemplate.md

latest6.5 KB
Original Source

SeriesTemplate.SeriesDataMember Property

Gets or sets the name of the data member whose values identify series.

Namespace : DevExpress.XtraCharts

Assembly : DevExpress.XtraCharts.v25.2.dll

NuGet Package : DevExpress.Charts

Declaration

csharp
[XtraChartsLocalizableCategory(XtraChartsCategory.Data)]
public string SeriesDataMember { get; set; }
vb
<XtraChartsLocalizableCategory(XtraChartsCategory.Data)>
Public Property SeriesDataMember As String

Property Value

TypeDescription
String

The name of the data member whose values identify series.

|

Example

The following code demonstrates how to automatically generate series and fill them with data from a data source. It uses the classes and properties below:

SymbolDescription
ChartControl.SeriesTemplateReturns the series template the chart uses to generate its series.
SeriesTemplateThe series template that the chart uses to generate its series.
SeriesTemplate.SeriesDataMemberGets or sets the name of the data member whose values identify series.
SeriesBase.ArgumentDataMemberGets or sets the name of the data field that contains series point arguments.
SeriesBase.ValueDataMembersGets a collection of the names of data fields that contain series point values.
csharp
class GdpInfo {
    public int Year { get; set; }
    public String Region { get; set; }
    public double Value { get; set; }
}

// ...
// Note that the GetGdpDataSource method is not a part of the Chart Control API.
// This method provides a data object list that the Chart should display.
List<GdpInfo> gdpDataSource = GetGdpDataSource();
chartControl.DataSource = gdpDataSource;
chartControl.SeriesTemplate.SeriesDataMember = "Year";
chartControl.SeriesTemplate.ArgumentDataMember = "Region";
chartControl.SeriesTemplate.ValueDataMembers.AddRange("Value");
// ...
vb
Class GdpInfo
    Public Property Year As Integer
    Public Property Region As String 
    Public Property Value As Double
End Class

' ...
' Note that the GetGdpDataSource method is not a part of the Chart Control API.
' This method provides a data object list that the Chart should display.
Dim gdpDataSource As List(Of GdpInfo) = GetGdpDataSource()
chartControl.DataSource = gdpDataSource;
chartControl.SeriesTemplate.SeriesDataMember = "Year";
chartControl.SeriesTemplate.ArgumentDataMember = "Region";
chartControl.SeriesTemplate.ValueDataMembers.AddRange("Value");
' ...

The following code snippets (auto-collected from DevExpress Examples) contain references to the SeriesDataMember 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.

webchartcontrol-how-to-change-auto-created-series-appearance/CS/BoundDataChangedExample/WebForm1.aspx.cs#L16

csharp
webChartControl.DataSource = seriesData;
webChartControl.SeriesTemplate.SeriesDataMember = "Year";
webChartControl.SeriesTemplate.ArgumentDataMember = "Region";

winforms-charts-create-stacked-bar-chart/CS/Series_StackedBarChart/Form1.cs#L21

csharp
chart.SeriesTemplate.ChangeView(ViewType.StackedBar);
chart.SeriesTemplate.SeriesDataMember = "Company";
chart.SeriesTemplate.SetDataMembers("Product", "Income");

winforms-charts-create-a-side-by-side-stacked-bars/CS/SideBySideStackedBarChart/Form1.cs#L24

csharp
chart.DataSource = GetChartData();
chart.SeriesTemplate.SeriesDataMember = "Month";
chart.SeriesTemplate.ArgumentDataMember = "Section";

webchartcontrol-how-to-change-auto-created-series-appearance/VB/BoundDataChangedExample/WebForm1.aspx.vb#L19

vb
webChartControl.DataSource = seriesData
webChartControl.SeriesTemplate.SeriesDataMember = "Year"
webChartControl.SeriesTemplate.ArgumentDataMember = "Region"

winforms-charts-create-stacked-bar-chart/VB/Series_StackedBarChart/Form1.vb#L23

vb
chart.SeriesTemplate.ChangeView(ViewType.StackedBar)
chart.SeriesTemplate.SeriesDataMember = "Company"
chart.SeriesTemplate.SetDataMembers("Product", "Income")

winforms-charts-create-a-side-by-side-stacked-bars/VB/SideBySideStackedBarChart/Form1.vb#L27

vb
chart.DataSource = GetChartData()
chart.SeriesTemplate.SeriesDataMember = "Month"
chart.SeriesTemplate.ArgumentDataMember = "Section"

See Also

SeriesTemplate Class

SeriesTemplate Members

DevExpress.XtraCharts Namespace