Class ChartSeries

Series

Inheritance
System.Object
StateManagedObject
RenderedObject
ChartSeries
Inherited Members
Namespace: Telerik.Reporting.Charting
Assembly: Telerik.Reporting.dll

Syntax

public class ChartSeries : RenderedObject, IChartingStateManagedItem, IChartingStateManager, IDisposable, IOrdering, ICloneable

Constructors

ChartSeries()

Creates a new instance of ChartSeries class.

Declaration
public ChartSeries()

ChartSeries(String)

Creates a new instance of ChartSeries class with given name

Declaration
public ChartSeries(string name)
Parameters
System.String name

Name of series

ChartSeries(String, ChartSeriesType)

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

Declaration
public ChartSeries(string name, ChartSeriesType type)
Parameters
System.String name

Name of series
ChartSeriesType type

Type of series

ChartSeries(String, ChartSeriesType, ChartSeriesCollection)

Creates a new instance of ChartSeries class.

Declaration
public ChartSeries(string name, ChartSeriesType type, ChartSeriesCollection parent)
Parameters
System.String name

Name of series
ChartSeriesType type

Type of series
ChartSeriesCollection parent

Parent of series

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

Creates a new instance of ChartSeries class.

Declaration
public ChartSeries(string seriesName, ChartSeriesType chartSeriesType, ChartSeriesCollection parent, ChartYAxisType yAxisType, StyleSeries style)
Parameters
System.String seriesName

Name of series
ChartSeriesType chartSeriesType

Type of series
ChartSeriesCollection parent

Parent of series
ChartYAxisType yAxisType

YAxisType(Primary or Secondary)
StyleSeries style

Style of series

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

Creates a new instance of ChartSeries class.

Declaration
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
System.String seriesName

Name of series
ChartSeriesType chartSeriesType

Type of series
ChartSeriesCollection parent

Parent of series
ChartYAxisType yAxisType

YAxisType(Primary or Secondary)
StyleSeries style

Style of series
System.String dataYColumn

DataSource column that is used to data-bind to the series YValue
System.String dataXColumn

DataSource column that is used to data-bind to the series XValue
System.String dataYColumn2

DataSource column that is used to data-bind to the series YValue2
System.String dataXColumn2

DataSource column that is used to data-bind to the series XValue2
System.String dataYColumn3

DataSource column that is used to data-bind to the series YValue3
System.String dataYColumn4

DataSource column that is used to data-bind to the series YValue4
System.String dataLabelsColumn

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

ChartSeries(ChartSeriesCollection)

Creates a new instance of ChartSeries class.

Declaration
public ChartSeries(ChartSeriesCollection parent)
Parameters
ChartSeriesCollection parent

Parent of series

Properties

ActiveRegionAttributes

Default attributes for series items' active regions

Declaration
public string ActiveRegionAttributes { get; set; }
Property Value
System.String

ActiveRegionToolTip

Default tooltip for series items' active regions

Declaration
public string ActiveRegionToolTip { get; set; }
Property Value
System.String

ActiveRegionUrl

Default url for series items' active regions

Declaration
public string ActiveRegionUrl { get; set; }
Property Value
System.String

Appearance

Specifies the visual appearance of series items.

Declaration
[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
public string DataLabelsColumn { get; set; }
Property Value
System.String

DataXColumn

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

Declaration
public string DataXColumn { get; set; }
Property Value
System.String

DataXColumn2

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

Declaration
public string DataXColumn2 { get; set; }
Property Value
System.String

DataYColumn

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

Declaration
public string DataYColumn { get; set; }
Property Value
System.String

DataYColumn2

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

Declaration
public string DataYColumn2 { get; set; }
Property Value
System.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
public string DataYColumn3 { get; set; }
Property Value
System.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
public string DataYColumn4 { get; set; }
Property Value
System.String

DefaultLabelValue

Specifies the default value for the series items labels.

Declaration
public string DefaultLabelValue { get; set; }
Property Value
System.String

Index

Current series index in the series collection

Declaration
public int Index { get; }
Property Value
System.Int32

IsActiveRegionSet

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

Declaration
public bool IsActiveRegionSet { get; }
Property Value
System.Boolean

IsDataBound

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

Declaration
public bool IsDataBound { get; }
Property Value
System.Boolean

Item[Int32]

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

Declaration
public ChartSeriesItem this[int itemIndex] { get; set; }
Parameters
System.Int32 itemIndex

Property Value
ChartSeriesItem

Items

Gets a collection of series items.

Declaration
[SkinnableProperty]
public ChartSeriesItemsCollection Items { get; }
Property Value
ChartSeriesItemsCollection

Name

Gets or sets the name of the data series.

Declaration
public string Name { get; set; }
Property Value
System.String

Parent

Parent element

Declaration
public ChartSeriesCollection Parent { get; }
Property Value
ChartSeriesCollection

PlotArea

Plot area element for series drawing

Declaration
public ChartPlotArea PlotArea { get; }
Property Value
ChartPlotArea

Type

Gets or sets the type of the series.

Declaration
public ChartSeriesType Type { get; set; }
Property Value
ChartSeriesType

Visible

Specifies whether to render the series or not.

Declaration
public bool Visible { get; set; }
Property Value
System.Boolean

YAxisType

Y Axis used by series

Declaration
public ChartYAxisType YAxisType { get; set; }
Property Value
ChartYAxisType

Methods

AddItem(List<ChartSeriesItem>)

Adds a series item(s) to the series.

Declaration
public void AddItem(List<ChartSeriesItem> seriesItems)
Parameters
System.Collections.Generic.List<ChartSeriesItem> seriesItems

Items to add

AddItem(Double)

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

Declaration
public void AddItem(double value)
Parameters
System.Double value

YValue of new item

AddItem(Double, String)

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

Declaration
public void AddItem(double value, string label)
Parameters
System.Double value

YValue of new item
System.String label

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
public void AddItem(double value, string label, Color color)
Parameters
System.Double value

YValue of new item
System.String label

Label of new item
System.Drawing.Color color

Color of new item

AddItem(Double, String, Color, Boolean)

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

Declaration
public void AddItem(double value, string label, Color color, bool exploded)
Parameters
System.Double value

YValue of new item
System.String label

Label of new item
System.Drawing.Color color

Color of new item
System.Boolean exploded

If item is exploded

AddItem(ChartSeriesItem, ChartSeriesItem[])

Adds a series item(s) to the series.

Declaration
public void AddItem(ChartSeriesItem seriesItem, params ChartSeriesItem[] seriesItems)
Parameters
ChartSeriesItem seriesItem

Item to add
ChartSeriesItem[] seriesItems

Items to add

AddItem(ChartSeriesItem[])

Adds a series item(s) to the series.

Declaration
public void AddItem(ChartSeriesItem[] seriesItems)
Parameters
ChartSeriesItem[] seriesItems

Items to add

AddItem(ChartSeriesItemsCollection)

Adds a series item(s) to the series.

Declaration
public void AddItem(ChartSeriesItemsCollection seriesItems)
Parameters
ChartSeriesItemsCollection seriesItems

Items to add

Clear()

Clears all series items from the data series.

Declaration
public void Clear()

ClearDataBoundState()

Removes data binding links from series

Declaration
public void ClearDataBoundState()

Clone()

Declaration
public object Clone()
Returns
System.Object

CloneSeries()

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

Declaration
public ChartSeries CloneSeries()
Returns
ChartSeries

New instance of ChartSeries with copied fields

CopyFrom(ChartSeries)

Copies settings from given series

Declaration
protected void CopyFrom(ChartSeries originalSeries)
Parameters
ChartSeries originalSeries

Series to copy from

CopyItems(ChartSeries)

Copies series items from given series

Declaration
protected void CopyItems(ChartSeries originalSeries)
Parameters
ChartSeries originalSeries

Series that items should be copied

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

LoadViewState(Object)

Load ViewState

Declaration
protected override void LoadViewState(object savedState)
Parameters
System.Object savedState

ViewState with data
Overrides

RemoveItem(Int32)

Removes the SeriesItem object at the specified index.

Declaration
public void RemoveItem(int itemIndex)
Parameters
System.Int32 itemIndex

Index to remove

RemoveItem(Int32, Int32[])

Removes a series item(s) from the series.

Declaration
public void RemoveItem(int index, params int[] indexes)
Parameters
System.Int32 index

Index of item should be removed
System.Int32[] indexes

Indexes of items should be removed

RemoveItem(ChartSeriesItem, ChartSeriesItem[])

Removes a series item(s) from the series.

Declaration
public void RemoveItem(ChartSeriesItem seriesItem, params ChartSeriesItem[] seriesItems)
Parameters
ChartSeriesItem seriesItem

Item for removing
ChartSeriesItem[] seriesItems

Items for removing

SaveViewState()

Save Track ViewState

Declaration
protected override object SaveViewState()
Returns
System.Object

Object data as array
Overrides

SetColors(Color[])

Sets new colors to the items in the data series.

Declaration
public void SetColors(params Color[] colors)
Parameters
System.Drawing.Color[] colors

New colors

SetExplodes(Boolean[])

Sets exploded statuses to the items in the data series.

Declaration
public void SetExplodes(params bool[] explodes)
Parameters
System.Boolean[] explodes

New exploded values

SetItemColor(Int32, Color)

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

Declaration
public void SetItemColor(int itemIndex, Color newColor)
Parameters
System.Int32 itemIndex

Index of item to change color
System.Drawing.Color newColor

New color of item

SetItemExplode(Int32, Boolean)

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

Declaration
public void SetItemExplode(int itemIndex, bool exploded)
Parameters
System.Int32 itemIndex

Index of item
System.Boolean exploded

Shoul be exploded or not

SetItemLabel(Int32, String)

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

Declaration
public void SetItemLabel(int itemIndex, string newLabel)
Parameters
System.Int32 itemIndex

Index of item to change label
System.String newLabel

New label

SetItems(ChartSeriesItem[])

Sets new SeriesItems objects to the data series.

Declaration
public void SetItems(params ChartSeriesItem[] seriesItems)
Parameters
ChartSeriesItem[] seriesItems

New Items to replace old items in series

SetItemValue(Int32, Double)

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

Declaration
public void SetItemValue(int itemIndex, double newValue)
Parameters
System.Int32 itemIndex

Index of item to change YValue
System.Double newValue

New YValue

SetLabels(String[])

Sets new labels to the items in the data series.

Declaration
public void SetLabels(params string[] labels)
Parameters
System.String[] labels

New labels

SetValues(Double[])

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

Declaration
public void SetValues(params double[] values)
Parameters
System.Double[] values

New values

ToString()

Overridden

Declaration
public override string ToString()
Returns
System.String

Series name
Overrides

TrackViewState()

Track ViewState

Declaration
protected override void TrackViewState()
Overrides