Chart Series Object - Series data and properties for a chart: More...

Inheritance diagram for QuantConnect.Series:

Public Member Functions
	Series ()
	Default constructor for chart series More...

	Series (string name)
	Constructor method for Chart Series More...

	Series (string name, SeriesType type, int index)
	Foundational constructor on the series class More...

	Series (string name, SeriesType type, int index, string unit)
	Foundational constructor on the series class More...

	Series (string name, SeriesType type=SeriesType.Line, string unit="$")
	Constructor method for Chart Series More...

	Series (string name, SeriesType type, string unit, Color color)
	Constructor method for Chart Series More...

	Series (string name, SeriesType type, string unit, Color color, ScatterMarkerSymbol symbol=ScatterMarkerSymbol.None)
	Constructor method for Chart Series More...

void	AddPoint (DateTime time, decimal value)
	Add a new point to this series More...

override void	AddPoint (ISeriesPoint point)
	Add a new point to this series More...

override void	AddPoint (DateTime time, List< decimal > values)
	Add a new point to this series More...

override ISeriesPoint	ConsolidateChartPoints ()
	Will sum up all chart points into a new single value, using the time of latest point More...

override BaseSeries	Clone (bool empty=false)
	Return a new instance clone of this object More...

Public Member Functions inherited from QuantConnect.BaseSeries
BaseSeries	GetUpdates ()
	Get the updates since the last call to this function. More...

void	Purge ()
	Removes the data from this series and resets the update position to 0 More...

IEnumerable< T >	GetValues< T > ()
	Returns an enumerable of the values of the series cast to the specified type More...

Properties
Color	Color = Color.Empty `[get, set]`
	Color the series More...

ScatterMarkerSymbol	ScatterMarkerSymbol = ScatterMarkerSymbol.None `[get, set]`
	Shape or symbol for the marker in a scatter plot More...

Properties inherited from QuantConnect.BaseSeries
string	Name `[get, set]`
	Name of the series. More...

string	Unit `[get, set]`
	Axis for the chart series. More...

int	Index `[get, set]`
	Index/position of the series on the chart. More...

string	IndexName `[get, set]`
	Axis name for the chart series. More...

int?	ZIndex `[get, set]`
	Defines the visual Z index of the series on the chart. More...

SeriesType	SeriesType `[get, set]`
	Chart type for the series: More...

string	Tooltip `[get, set]`
	An optional tooltip template More...

List< ISeriesPoint >	Values `[get, set]`
	The series list of values. These values are assumed to be in ascending time order (first points earliest, last points latest) More...

Additional Inherited Members
Static Public Member Functions inherited from QuantConnect.BaseSeries
static BaseSeries	Create (SeriesType seriesType, string name, int index=0, string unit="$")
	Creates a series according to the specified type. More...

Protected Member Functions inherited from QuantConnect.BaseSeries
	BaseSeries ()
	Default constructor for chart series More...

	BaseSeries (string name, SeriesType type)
	Constructor method for Chart Series More...

	BaseSeries (string name, SeriesType type, int index)
	Foundational constructor on the series class More...

	BaseSeries (string name, SeriesType type, int index, string unit)
	Foundational constructor on the series class More...

	BaseSeries (string name, SeriesType type, string unit)
	Constructor method for Chart Series More...

List< ISeriesPoint >	CloneValues ()
	Return a list of cloned values More...

Detailed Description

Chart Series Object - Series data and properties for a chart:

Definition at line 31 of file Series.cs.

Constructor & Destructor Documentation

◆ Series() [1/7]

QuantConnect.Series.Series ( )

Default constructor for chart series

Definition at line 47 of file Series.cs.

Here is the caller graph for this function:

◆ Series() [2/7]

QuantConnect.Series.Series ( string name )

Constructor method for Chart Series

Parameters

name	Name of the chart series

Definition at line 53 of file Series.cs.

◆ Series() [3/7]

QuantConnect.Series.Series	(	string	name,
		SeriesType	type,
		int	index
	)

Foundational constructor on the series class

Parameters

name	Name of the series
type	Type of the series
index	Index position on the chart of the series

Definition at line 64 of file Series.cs.

◆ Series() [4/7]

QuantConnect.Series.Series	(	string	name,
		SeriesType	type,
		int	index,
		string	unit
	)

Foundational constructor on the series class

Parameters

name	Name of the series
type	Type of the series
index	Index position on the chart of the series
unit	Unit for the series axis

Definition at line 76 of file Series.cs.

◆ Series() [5/7]

QuantConnect.Series.Series	(	string	name,
		SeriesType	type = `SeriesType.Line`,
		string	unit = `"$"`
	)

Constructor method for Chart Series

Parameters

name	Name of the chart series
type	Type of the chart series
unit	Unit of the series

Definition at line 88 of file Series.cs.

◆ Series() [6/7]

QuantConnect.Series.Series	(	string	name,
		SeriesType	type,
		string	unit,
		Color	color
	)

Constructor method for Chart Series

Parameters

name	Name of the chart series
type	Type of the chart series
unit	Unit of the series
color	Color of the series

Definition at line 100 of file Series.cs.

◆ Series() [7/7]

QuantConnect.Series.Series	(	string	name,
		SeriesType	type,
		string	unit,
		Color	color,
		ScatterMarkerSymbol	symbol = `ScatterMarkerSymbol.None`
	)

Constructor method for Chart Series

Parameters

name	Name of the chart series
type	Type of the chart series
unit	Unit of the series
color	Color of the series
symbol	Symbol for the marker in a scatter plot series

Definition at line 113 of file Series.cs.

Member Function Documentation

◆ AddPoint() [1/3]

void QuantConnect.Series.AddPoint	(	DateTime	time,
		decimal	value
	)

Add a new point to this series

Parameters

time	Time of the chart point
value	Value of the chart point

Definition at line 125 of file Series.cs.

Here is the caller graph for this function:

◆ AddPoint() [2/3]

override void QuantConnect.Series.AddPoint ( ISeriesPoint point )

virtual

Add a new point to this series

Parameters

point The data point to add

Reimplemented from QuantConnect.BaseSeries.

Definition at line 143 of file Series.cs.

◆ AddPoint() [3/3]

override void QuantConnect.Series.AddPoint	(	DateTime	time,
		List< decimal >	values
	)

virtual

Add a new point to this series

Parameters

time	The time of the data point
values	The values of the data point

Implements QuantConnect.BaseSeries.

Definition at line 158 of file Series.cs.

Here is the call graph for this function:

◆ ConsolidateChartPoints()

override ISeriesPoint QuantConnect.Series.ConsolidateChartPoints ( )

virtual

Will sum up all chart points into a new single value, using the time of latest point

Returns: The new chart point

Implements QuantConnect.BaseSeries.

Definition at line 172 of file Series.cs.

◆ Clone()

override BaseSeries QuantConnect.Series.Clone ( bool empty = false )

virtual

Return a new instance clone of this object

Returns

Implements QuantConnect.BaseSeries.

Definition at line 193 of file Series.cs.

Here is the call graph for this function:

Property Documentation

◆ Color

Color QuantConnect.Series.Color = Color.Empty

getset

Color the series

Definition at line 37 of file Series.cs.

◆ ScatterMarkerSymbol

ScatterMarkerSymbol QuantConnect.Series.ScatterMarkerSymbol = ScatterMarkerSymbol.None

getset

Shape or symbol for the marker in a scatter plot

Definition at line 42 of file Series.cs.

The documentation for this class was generated from the following file:

Common/Series.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Series() [1/7]

◆ Series() [2/7]

◆ Series() [3/7]

◆ Series() [4/7]

◆ Series() [5/7]

◆ Series() [6/7]

◆ Series() [7/7]

Member Function Documentation

◆ AddPoint() [1/3]

◆ AddPoint() [2/3]

◆ AddPoint() [3/3]

◆ ConsolidateChartPoints()

◆ Clone()

Property Documentation

◆ Color

◆ ScatterMarkerSymbol