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

Inheritance diagram for QuantConnect.CandlestickSeries:

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

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

	CandlestickSeries (string name, int index)
	Foundational constructor on the series class More...

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

	CandlestickSeries (string name, string unit)
	Constructor method for Chart Series More...

void	AddPoint (DateTime time, decimal open, decimal high, decimal low, decimal close)
	Add a new point to this series More...

void	AddPoint (TradeBar bar)
	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 candlesticks into a new single one, 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...

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

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

Detailed Description

Candlestick Chart Series Object - Series data and properties for a candlestick chart

Definition at line 28 of file CandlestickSeries.cs.

Constructor & Destructor Documentation

◆ CandlestickSeries() [1/5]

QuantConnect.CandlestickSeries.CandlestickSeries ( )

Default constructor for chart series

Definition at line 33 of file CandlestickSeries.cs.

Here is the caller graph for this function:

◆ CandlestickSeries() [2/5]

QuantConnect.CandlestickSeries.CandlestickSeries ( string name )

Constructor method for Chart Series

Parameters

name	Name of the chart series

Definition at line 42 of file CandlestickSeries.cs.

◆ CandlestickSeries() [3/5]

QuantConnect.CandlestickSeries.CandlestickSeries	(	string	name,
		int	index
	)

Foundational constructor on the series class

Parameters

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

Definition at line 52 of file CandlestickSeries.cs.

◆ CandlestickSeries() [4/5]

QuantConnect.CandlestickSeries.CandlestickSeries	(	string	name,
		int	index,
		string	unit
	)

Foundational constructor on the series class

Parameters

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

Definition at line 63 of file CandlestickSeries.cs.

◆ CandlestickSeries() [5/5]

QuantConnect.CandlestickSeries.CandlestickSeries	(	string	name,
		string	unit
	)

Constructor method for Chart Series

Parameters

name	Name of the chart series
unit	Unit of the series

Definition at line 74 of file CandlestickSeries.cs.

Member Function Documentation

◆ AddPoint() [1/4]

void QuantConnect.CandlestickSeries.AddPoint	(	DateTime	time,
		decimal	open,
		decimal	high,
		decimal	low,
		decimal	close
	)

Add a new point to this series

Parameters

time	Time of the chart point
open	Candlestick open price
high	Candlestick high price
low	Candlestick low price
close	Candlestick close price

Definition at line 87 of file CandlestickSeries.cs.

◆ AddPoint() [2/4]

void QuantConnect.CandlestickSeries.AddPoint ( TradeBar bar )

Add a new point to this series

Definition at line 95 of file CandlestickSeries.cs.

◆ AddPoint() [3/4]

override void QuantConnect.CandlestickSeries.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 104 of file CandlestickSeries.cs.

◆ AddPoint() [4/4]

override void QuantConnect.CandlestickSeries.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 119 of file CandlestickSeries.cs.

◆ ConsolidateChartPoints()

override ISeriesPoint QuantConnect.CandlestickSeries.ConsolidateChartPoints ( )

virtual

Will sum up all candlesticks into a new single one, using the time of latest point

Returns: The new candlestick

Implements QuantConnect.BaseSeries.

Definition at line 133 of file CandlestickSeries.cs.

◆ Clone()

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

virtual

Return a new instance clone of this object

Returns

Implements QuantConnect.BaseSeries.

Definition at line 173 of file CandlestickSeries.cs.

Here is the call graph for this function:

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

Common/CandlestickSeries.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CandlestickSeries() [1/5]

◆ CandlestickSeries() [2/5]

◆ CandlestickSeries() [3/5]

◆ CandlestickSeries() [4/5]

◆ CandlestickSeries() [5/5]

Member Function Documentation

◆ AddPoint() [1/4]

◆ AddPoint() [2/4]

◆ AddPoint() [3/4]

◆ AddPoint() [4/4]

◆ ConsolidateChartPoints()

◆ Clone()