ClassChartSeries
Series
Definition
Namespace:Telerik.Reporting.Charting
Assembly:Telerik.Reporting.dll
Syntax:
[TypeConverter(typeof(ExpandableObjectConverter))]
public class ChartSeries : RenderedObject, IChartingStateManagedItem, IChartingStateManager, IOrderingInheritance: objectStateManagedObjectRenderedObjectChartSeries
Implements:
Inherited Members
Constructors
ChartSeries()
Creates a new instance of ChartSeries class.
Declaration
public ChartSeries()ChartSeries(ChartSeriesCollection)
Creates a new instance of ChartSeries class.
Declaration
public ChartSeries(ChartSeriesCollection parent)Parameters
parent
Parent of series
ChartSeries(string)
Creates a new instance of ChartSeries class with given name
Declaration
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
public ChartSeries(string name, ChartSeriesType type)Parameters
name
string
Name of series
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
name
string
Name of series
type
Type of series
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
seriesName
string
Name of series
chartSeriesType
Type of series
parent
Parent of series
yAxisType
YAxisType(Primary or Secondary)
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
seriesName
string
Name of series
chartSeriesType
Type of series
parent
Parent of series
yAxisType
YAxisType(Primary or Secondary)
style
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
[PersistenceMode(PersistenceMode.Attribute)]
public string ActiveRegionAttributes { get; set; }Property Value
string
ActiveRegionToolTip
Default tooltip for series items' active regions
Declaration
[PersistenceMode(PersistenceMode.Attribute)]
public string ActiveRegionToolTip { get; set; }Property Value
string
ActiveRegionUrl
Default url for series items' active regions
Declaration
[PersistenceMode(PersistenceMode.Attribute)]
public string ActiveRegionUrl { get; set; }Property Value
string
Appearance
Specifies the visual appearance of series items.
Declaration
[TypeConverter(typeof(ExpandableObjectConverter))]
[Browsable(true)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[SkinnableProperty]
public StyleSeries Appearance { get; }Property Value
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
[PersistenceMode(PersistenceMode.Attribute)]
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
[PersistenceMode(PersistenceMode.Attribute)]
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
[PersistenceMode(PersistenceMode.Attribute)]
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
[PersistenceMode(PersistenceMode.Attribute)]
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
[PersistenceMode(PersistenceMode.Attribute)]
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
[PersistenceMode(PersistenceMode.Attribute)]
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
[PersistenceMode(PersistenceMode.Attribute)]
public string DataYColumn4 { get; set; }Property Value
string
DefaultLabelValue
Specifies the default value for the series items labels.
Declaration
[Browsable(true)]
public string DefaultLabelValue { get; set; }Property Value
string
Index
Current series index in the series collection
Declaration
[Bindable(false)]
[Browsable(false)]
public int Index { get; }Property Value
int
IsActiveRegionSet
Returns whether there is an active region associated with the series.
Declaration
[Browsable(false)]
public bool IsActiveRegionSet { get; }Property Value
bool
IsDataBound
Determines whether the series is configured as data bound or not.
Declaration
[Browsable(false)]
public bool IsDataBound { get; }Property Value
bool
Items
Gets a collection of series items.
Declaration
[PersistenceMode(PersistenceMode.InnerProperty)]
[SkinnableProperty]
public ChartSeriesItemsCollection Items { get; }Property Value
Name
Gets or sets the name of the data series.
Declaration
public string Name { get; set; }Property Value
string
Parent
Parent element
Declaration
[Browsable(false)]
public ChartSeriesCollection Parent { get; }Property Value
PlotArea
Plot area element for series drawing
Declaration
[Browsable(false)]
public ChartPlotArea PlotArea { get; }Property Value
Type
Gets or sets the type of the series.
Declaration
public ChartSeriesType Type { get; set; }Property Value
Visible
Specifies whether to render the series or not.
Declaration
public bool Visible { get; set; }Property Value
bool
YAxisType
Y Axis used by series
Declaration
public ChartYAxisType YAxisType { get; set; }Property Value
this[int]
Gets or sets a ChartSeries SeriesItem object at the specified index.
Declaration
[Browsable(false)]
public ChartSeriesItem this[int itemIndex] { get; set; }Parameters
itemIndex
int
Property Value
Methods
AddItem(ChartSeriesItem, params ChartSeriesItem[])
Adds a series item(s) to the series.
Declaration
public void AddItem(ChartSeriesItem seriesItem, params ChartSeriesItem[] seriesItems)Parameters
seriesItem
Item to add
seriesItems
Items to add
AddItem(ChartSeriesItem[])
Adds a series item(s) to the series.
Declaration
public void AddItem(ChartSeriesItem[] seriesItems)Parameters
seriesItems
Items to add
AddItem(ChartSeriesItemsCollection)
Adds a series item(s) to the series.
Declaration
public void AddItem(ChartSeriesItemsCollection seriesItems)Parameters
seriesItems
Items to add
AddItem(List<ChartSeriesItem>)
Adds a series item(s) to the series.
Declaration
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
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
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
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
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
public void Clear()ClearDataBoundState()
Removes data binding links from series
Declaration
public void ClearDataBoundState()CloneSeries()
Return new ChartSeries instance with copied all properties from source object and cloned Items collection
Declaration
public ChartSeries CloneSeries()Returns
New instance of ChartSeries with copied fields
CopyFrom(ChartSeries)
Copies settings from given series
Declaration
protected void CopyFrom(ChartSeries originalSeries)Parameters
originalSeries
Series to copy from
CopyItems(ChartSeries)
Copies series items from given series
Declaration
protected void CopyItems(ChartSeries originalSeries)Parameters
originalSeries
Series that items should be copied
Dispose(bool)
Releases unmanaged and - optionally - managed resources
Declaration
protected override void Dispose(bool disposing)Parameters
disposing
bool
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
savedState
object
ViewState with data
Overrides
RemoveItem(ChartSeriesItem, params ChartSeriesItem[])
Removes a series item(s) from the series.
Declaration
public void RemoveItem(ChartSeriesItem seriesItem, params ChartSeriesItem[] seriesItems)Parameters
seriesItem
Item for removing
seriesItems
Items for removing
RemoveItem(int)
Removes the SeriesItem object at the specified index.
Declaration
public void RemoveItem(int itemIndex)Parameters
itemIndex
int
Index to remove
RemoveItem(int, params int[])
Removes a series item(s) from the series.
Declaration
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
protected override object SaveViewState()Returns
object
Object data as array
Overrides
SetColors(params Color[])
Sets new colors to the items in the data series.
Declaration
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
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
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
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
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
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
public void SetItems(params ChartSeriesItem[] seriesItems)Parameters
seriesItems
New Items to replace old items in series
SetLabels(params string[])
Sets new labels to the items in the data series.
Declaration
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
public void SetValues(params double[] values)Parameters
values
double[]
New values
ToString()
Overridden
Declaration
public override string ToString()Returns
string
Series name
Overrides
TrackViewState()
Track ViewState
Declaration
protected override void TrackViewState()Overrides