Class
ChartSeries

Series

Definition

Namespace:Telerik.Charting

Assembly:Telerik.WinControls.RadChart.dll

Syntax:

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
public class ChartSeries : RenderedObject, IChartingStateManagedItem, IChartingStateManager, IOrdering, ICloneable

Inheritance: objectStateManagedObjectRenderedObjectChartSeries

Implements: IChartingStateManagedItemIChartingStateManagerICloneableIOrdering

Inherited Members RenderedObject.objectContainerRenderedObject.GetOrder()RenderedObject.SetOrder(int)RenderedObject.Remove()RenderedObject.BringForward()RenderedObject.BringToFront()RenderedObject.SendBackward()RenderedObject.SendToBack()RenderedObject.ContainerStateManagedObject.CloneState()StateManagedObject.SetDirty()StateManagedObject.ViewStateIgnoresCase

Constructors

ChartSeries()

Creates a new instance of ChartSeries class.

Declaration

cs-api-definition
public ChartSeries()

ChartSeries(ChartSeriesCollection)

Creates a new instance of ChartSeries class.

Declaration

cs-api-definition
public ChartSeries(ChartSeriesCollection parent)

Parameters

parent

ChartSeriesCollection

Parent of series

ChartSeries(string)

Creates a new instance of ChartSeries class with given name

Declaration

cs-api-definition
public ChartSeries(string name)

Parameters

name

string

Name of series

ChartSeries(string, ChartSeriesType)

Creates a new instance of ChartSeries class with given name and type.

Declaration

cs-api-definition
public ChartSeries(string name, ChartSeriesType type)

Parameters

name

string

Name of series

type

ChartSeriesType

Type of series

ChartSeries(string, ChartSeriesType, ChartSeriesCollection)

Creates a new instance of ChartSeries class.

Declaration

cs-api-definition
public ChartSeries(string name, ChartSeriesType type, ChartSeriesCollection parent)

Parameters

name

string

Name of series

type

ChartSeriesType

Type of series

parent

ChartSeriesCollection

Parent of series

ChartSeries(string, ChartSeriesType, ChartSeriesCollection, ChartYAxisType, StyleSeries)

Creates a new instance of ChartSeries class.

Declaration

cs-api-definition
public ChartSeries(string seriesName, ChartSeriesType chartSeriesType, ChartSeriesCollection parent, ChartYAxisType yAxisType, StyleSeries style)

Parameters

seriesName

string

Name of series

chartSeriesType

ChartSeriesType

Type of series

parent

ChartSeriesCollection

Parent of series

yAxisType

ChartYAxisType

YAxisType(Primary or Secondary)

style

StyleSeries

Style of series

ChartSeries(string, ChartSeriesType, ChartSeriesCollection, ChartYAxisType, StyleSeries, string, string, string, string, string, string, string)

Creates a new instance of ChartSeries class.

Declaration

cs-api-definition
public ChartSeries(string seriesName, ChartSeriesType chartSeriesType, ChartSeriesCollection parent, ChartYAxisType yAxisType, StyleSeries style, string dataYColumn, string dataXColumn, string dataYColumn2, string dataXColumn2, string dataYColumn3, string dataYColumn4, string dataLabelsColumn)

Parameters

seriesName

string

Name of series

chartSeriesType

ChartSeriesType

Type of series

parent

ChartSeriesCollection

Parent of series

yAxisType

ChartYAxisType

YAxisType(Primary or Secondary)

style

StyleSeries

Style of series

dataYColumn

string

DataSource column that is used to data-bind to the series YValue

dataXColumn

string

DataSource column that is used to data-bind to the series XValue

dataYColumn2

string

DataSource column that is used to data-bind to the series YValue2

dataXColumn2

string

DataSource column that is used to data-bind to the series XValue2

dataYColumn3

string

DataSource column that is used to data-bind to the series YValue3

dataYColumn4

string

DataSource column that is used to data-bind to the series YValue4

dataLabelsColumn

string

DataSource column (member) that will be used as ChartSeries names source when Y-values are taken from one column for a several chart ChartSeries

Properties

ActiveRegionAttributes

Default attributes for series items' active regions

Declaration

cs-api-definition
public string ActiveRegionAttributes { get; set; }

Property Value

string

ActiveRegionToolTip

Default tooltip for series items' active regions

Declaration

cs-api-definition
public string ActiveRegionToolTip { get; set; }

Property Value

string

ActiveRegionUrl

Default url for series items' active regions

Declaration

cs-api-definition
public string ActiveRegionUrl { get; set; }

Property Value

string

Appearance

Specifies the visual appearance of series items.

Declaration

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
[Browsable(true)]
[SkinnableProperty]
public StyleSeries Appearance { get; }

Property Value

StyleSeries

DataLabelsColumn

Gets or sets the name of the DataSource column (member) that will be used as ChartSeries names source when Y-values are taken from one column for a several chart ChartSeries

Declaration

cs-api-definition
public string DataLabelsColumn { get; set; }

Property Value

string

DataXColumn

Gets or sets the name of the DataSource column (member) that is used to data-bind to the series X-value

Declaration

cs-api-definition
public string DataXColumn { get; set; }

Property Value

string

DataXColumn2

Gets or sets the name of the DataSource column (member) that is used to data-bind to the series X2-value

Declaration

cs-api-definition
public string DataXColumn2 { get; set; }

Property Value

string

DataYColumn

Gets or sets the name of the DataSource column (member) that is used to data-bind to the series Y-value

Declaration

cs-api-definition
public string DataYColumn { get; set; }

Property Value

string

DataYColumn2

Gets or sets the name of the DataSource column (member) that is used to data-bind to the series Y2-value

Declaration

cs-api-definition
public string DataYColumn2 { get; set; }

Property Value

string

DataYColumn3

Gets or sets the name of the DataSource column (member) that is used to data-bind to the series Y3-value (High for CandleStick chart).

Declaration

cs-api-definition
public string DataYColumn3 { get; set; }

Property Value

string

DataYColumn4

Gets or sets the name of the DataSource column (member) that is used to data-bind to the series Y4-value (Low for CandleStick chart).

Declaration

cs-api-definition
public string DataYColumn4 { get; set; }

Property Value

string

DefaultLabelValue

Specifies the default value for the series items labels.

Declaration

cs-api-definition
[Browsable(true)]
public string DefaultLabelValue { get; set; }

Property Value

string

Index

Current series index in the series collection

Declaration

cs-api-definition
[Bindable(false)]
[Browsable(false)]
public int Index { get; }

Property Value

int

IsActiveRegionSet

Returns whether there is an active region associated with the series.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsActiveRegionSet { get; }

Property Value

bool

IsDataBound

Determines whether the series is configured as data bound or not.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsDataBound { get; }

Property Value

bool

Items

Gets a collection of series items.

Declaration

cs-api-definition
[SkinnableProperty]
public ChartSeriesItemsCollection Items { get; }

Property Value

ChartSeriesItemsCollection

Name

Gets or sets the name of the data series.

Declaration

cs-api-definition
public string Name { get; set; }

Property Value

string

Parent

Parent element

Declaration

cs-api-definition
[Browsable(false)]
public ChartSeriesCollection Parent { get; }

Property Value

ChartSeriesCollection

PlotArea

Plot area element for series drawing

Declaration

cs-api-definition
[Browsable(false)]
public ChartPlotArea PlotArea { get; }

Property Value

ChartPlotArea

Type

Gets or sets the type of the series.

Declaration

cs-api-definition
public ChartSeriesType Type { get; set; }

Property Value

ChartSeriesType

Visible

Specifies whether to render the series or not.

Declaration

cs-api-definition
public bool Visible { get; set; }

Property Value

bool

YAxisType

Y Axis used by series

Declaration

cs-api-definition
public ChartYAxisType YAxisType { get; set; }

Property Value

ChartYAxisType

this[int]

Gets or sets a ChartSeries SeriesItem object at the specified index.

Declaration

cs-api-definition
[Browsable(false)]
public ChartSeriesItem this[int itemIndex] { get; set; }

Parameters

itemIndex

int

Property Value

ChartSeriesItem

Methods

AddItem(ChartSeriesItem, params ChartSeriesItem[])

Adds a series item(s) to the series.

Declaration

cs-api-definition
public void AddItem(ChartSeriesItem seriesItem, params ChartSeriesItem[] seriesItems)

Parameters

seriesItem

ChartSeriesItem

Item to add

seriesItems

ChartSeriesItem[]

Items to add

AddItem(ChartSeriesItem[])

Adds a series item(s) to the series.

Declaration

cs-api-definition
public void AddItem(ChartSeriesItem[] seriesItems)

Parameters

seriesItems

ChartSeriesItem[]

Items to add

AddItem(ChartSeriesItemsCollection)

Adds a series item(s) to the series.

Declaration

cs-api-definition
public void AddItem(ChartSeriesItemsCollection seriesItems)

Parameters

seriesItems

ChartSeriesItemsCollection

Items to add

AddItem(List<ChartSeriesItem>)

Adds a series item(s) to the series.

Declaration

cs-api-definition
public void AddItem(List<ChartSeriesItem> seriesItems)

Parameters

seriesItems

List<ChartSeriesItem>

Items to add

AddItem(double)

Adds a new series item to the data series by specifying its value.

Declaration

cs-api-definition
public void AddItem(double value)

Parameters

value

double

YValue of new item

AddItem(double, string)

Adds a new series item to the data series by specifying its value and label.

Declaration

cs-api-definition
public void AddItem(double value, string label)

Parameters

value

double

YValue of new item

label

string

Label of new item

AddItem(double, string, Color)

Adds a new series item to the data series by specifying its value, label and color.

Declaration

cs-api-definition
public void AddItem(double value, string label, Color color)

Parameters

value

double

YValue of new item

label

string

Label of new item

color

Color

Color of new item

AddItem(double, string, Color, bool)

Adds a new series item to the data series by specifying its value, label, color and explosion.

Declaration

cs-api-definition
public void AddItem(double value, string label, Color color, bool exploded)

Parameters

value

double

YValue of new item

label

string

Label of new item

color

Color

Color of new item

exploded

bool

If item is exploded

Clear()

Clears all series items from the data series.

Declaration

cs-api-definition
public void Clear()

ClearDataBoundState()

Removes data binding links from series

Declaration

cs-api-definition
public void ClearDataBoundState()

CloneSeries()

Return new ChartSeries instance with copied all properties from source object and cloned Items collection

Declaration

cs-api-definition
public ChartSeries CloneSeries()

Returns

ChartSeries

New instance of ChartSeries with copied fields

CopyFrom(ChartSeries)

Copies settings from given series

Declaration

cs-api-definition
protected void CopyFrom(ChartSeries originalSeries)

Parameters

originalSeries

ChartSeries

Series to copy from

CopyItems(ChartSeries)

Copies series items from given series

Declaration

cs-api-definition
protected void CopyItems(ChartSeries originalSeries)

Parameters

originalSeries

ChartSeries

Series that items should be copied

LoadViewState(object)

Load ViewState

Declaration

cs-api-definition
protected override void LoadViewState(object savedState)

Parameters

savedState

object

ViewState with data

Overrides StateManagedObject.LoadViewState(object)

RemoveItem(ChartSeriesItem, params ChartSeriesItem[])

Removes a series item(s) from the series.

Declaration

cs-api-definition
public void RemoveItem(ChartSeriesItem seriesItem, params ChartSeriesItem[] seriesItems)

Parameters

seriesItem

ChartSeriesItem

Item for removing

seriesItems

ChartSeriesItem[]

Items for removing

RemoveItem(int)

Removes the SeriesItem object at the specified index.

Declaration

cs-api-definition
public void RemoveItem(int itemIndex)

Parameters

itemIndex

int

Index to remove

RemoveItem(int, params int[])

Removes a series item(s) from the series.

Declaration

cs-api-definition
public void RemoveItem(int index, params int[] indexes)

Parameters

index

int

Index of item should be removed

indexes

int[]

Indexes of items should be removed

SaveViewState()

Save Track ViewState

Declaration

cs-api-definition
protected override object SaveViewState()

Returns

object

Object data as array

Overrides StateManagedObject.SaveViewState()

SetColors(params Color[])

Sets new colors to the items in the data series.

Declaration

cs-api-definition
public void SetColors(params Color[] colors)

Parameters

colors

Color[]

New colors

SetExplodes(params bool[])

Sets exploded statuses to the items in the data series.

Declaration

cs-api-definition
public void SetExplodes(params bool[] explodes)

Parameters

explodes

bool[]

New exploded values

SetItemColor(int, Color)

Sets a new color to the series item at the specified index.

Declaration

cs-api-definition
public void SetItemColor(int itemIndex, Color newColor)

Parameters

itemIndex

int

Index of item to change color

newColor

Color

New color of item

SetItemExplode(int, bool)

Sets a new explode status for the series item at the specified index.

Declaration

cs-api-definition
public void SetItemExplode(int itemIndex, bool exploded)

Parameters

itemIndex

int

Index of item

exploded

bool

Shoul be exploded or not

SetItemLabel(int, string)

Sets a new label for the series item at the specified index.

Declaration

cs-api-definition
public void SetItemLabel(int itemIndex, string newLabel)

Parameters

itemIndex

int

Index of item to change label

newLabel

string

New label

SetItemValue(int, double)

Sets a new value for the series item at the specified index.

Declaration

cs-api-definition
public void SetItemValue(int itemIndex, double newValue)

Parameters

itemIndex

int

Index of item to change YValue

newValue

double

New YValue

SetItems(params ChartSeriesItem[])

Sets new SeriesItems objects to the data series.

Declaration

cs-api-definition
public void SetItems(params ChartSeriesItem[] seriesItems)

Parameters

seriesItems

ChartSeriesItem[]

New Items to replace old items in series

SetLabels(params string[])

Sets new labels to the items in the data series.

Declaration

cs-api-definition
public void SetLabels(params string[] labels)

Parameters

labels

string[]

New labels

SetValues(params double[])

Sets new values to the data series by passing an array of real values. Old values are cleared.

Declaration

cs-api-definition
public void SetValues(params double[] values)

Parameters

values

double[]

New values

ToString()

Overridden

Declaration

cs-api-definition
public override string ToString()

Returns

string

Series name

Overrides StateManagedObject.ToString()

TrackViewState()

Track ViewState

Declaration

cs-api-definition
protected override void TrackViewState()

Overrides StateManagedObject.TrackViewState()