SeriesTemplate Class

The series template that the chart uses to generate its series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[TypeConverter(typeof(SeriesTemplateTypeConverter))]
public class SeriesTemplate :
    SeriesBase,
    ISeriesFactory,
    ISeriesPointFactory,
    ISeriesTemplate

VB.NET

<TypeConverter(GetType(SeriesTemplateTypeConverter))>
Public Class SeriesTemplate
    Inherits SeriesBase
    Implements ISeriesFactory,
               ISeriesPointFactory,
               ISeriesTemplate

Related API Members

The following members return SeriesTemplate objects:

Library	Related API Members
Cross-Platform Class Library	BreadcrumbItem.Template
	SeriesTemplate.ArgumentDrillTemplate
	SeriesTemplate.SeriesDrillTemplate
	SeriesTemplate.SeriesPointDrillTemplate
WinForms Controls	ChartControl.SeriesTemplate
ASP.NET MVC Extensions	ChartControlSettings.SeriesTemplate
ASP.NET Web Forms Controls	WebChartControl.SeriesTemplate
.NET Reporting Tools	XRChart.SeriesTemplate

Remarks

The example uses the following classes and members:

Symbol	Description
ChartControl.SeriesTemplate for WinForms, WebChartControl.SeriesTemplate for ASP.NET WebForms, ChartControlSettings.SeriesTemplate for ASP.NET MVC	Returns the series template the chart uses to generate its series.
SeriesTemplate.SeriesDataMember	Gets or sets the name of the data member whose values identify series.
SeriesBase.ArgumentDataMember	Gets or sets the name of the data field that contains series point arguments.
SeriesBase.ValueDataMembers	Gets a collection of the names of data fields that contain series point values.

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:

Symbol	Description
ChartControl.SeriesTemplate	Returns the series template the chart uses to generate its series.
SeriesTemplate	The series template that the chart uses to generate its series.
SeriesTemplate.SeriesDataMember	Gets or sets the name of the data member whose values identify series.
SeriesBase.ArgumentDataMember	Gets or sets the name of the data field that contains series point arguments.
SeriesBase.ValueDataMembers	Gets a collection of the names of data fields that contain series point values.

C#

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.NET

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");
' ...

Implements

IXtraSupportDeserializeCollectionItem

Inheritance

Object

ChartElement

SeriesBase

SeriesTemplate