Lean  $LEAN_TAG$
QuantConnect.Candlestick Class Reference

Single candlestick for a candlestick chart More...

Inheritance diagram for QuantConnect.Candlestick:
[legend]

Public Member Functions

 Candlestick ()
 Default constructor More...
 
 Candlestick (long time, decimal? open, decimal? high, decimal? low, decimal? close)
 Constructor taking the candlestick values More...
 
 Candlestick (DateTime time, decimal? open, decimal? high, decimal? low, decimal? close)
 Constructor taking candlestick values and time in DateTime format More...
 
 Candlestick (TradeBar bar)
 Constructor taking candlestick values and time in DateTime format More...
 
 Candlestick (DateTime time, Bar bar)
 Constructor taking candlestick values and time in DateTime format More...
 
 Candlestick (Candlestick candlestick)
 Copy constructor More...
 
override string ToString ()
 Provides a readable string representation of this instance. More...
 
ISeriesPoint Clone ()
 Clones this instance More...
 
void Update (decimal? value)
 Updates the candlestick with a new value. This will aggregate the OHLC bar More...
 
void Update (decimal value)
 Updates the candlestick with a new value. This will aggregate the OHLC bar More...
 

Properties

DateTime Time [get, set]
 The candlestick time More...
 
long LongTime [get]
 The candlestick time in seconds since Unix Epoch More...
 
decimal? Open [get, set]
 The candlestick open price More...
 
decimal? High [get, set]
 The candlestick high price More...
 
decimal? Low [get, set]
 The candlestick low price More...
 
decimal? Close [get, set]
 The candlestick close price More...
 
- Properties inherited from QuantConnect.ISeriesPoint
DateTime Time [get, set]
 Time of this chart series point More...
 

Detailed Description

Single candlestick for a candlestick chart

Definition at line 27 of file Candlestick.cs.

Constructor & Destructor Documentation

◆ Candlestick() [1/6]

QuantConnect.Candlestick.Candlestick ( )

Default constructor

Definition at line 90 of file Candlestick.cs.

Here is the caller graph for this function:

◆ Candlestick() [2/6]

QuantConnect.Candlestick.Candlestick ( long  time,
decimal?  open,
decimal?  high,
decimal?  low,
decimal?  close 
)

Constructor taking the candlestick values

Parameters
timeCandlestick time in seconds since Unix Epoch
openCandlestick open price
highCandlestick high price
lowCandlestick low price
closeCandlestick close price

Definition at line 100 of file Candlestick.cs.

◆ Candlestick() [3/6]

QuantConnect.Candlestick.Candlestick ( DateTime  time,
decimal?  open,
decimal?  high,
decimal?  low,
decimal?  close 
)

Constructor taking candlestick values and time in DateTime format

Parameters
timeCandlestick time in seconds
openCandlestick open price
highCandlestick high price
lowCandlestick low price
closeCandlestick close price

Definition at line 113 of file Candlestick.cs.

◆ Candlestick() [4/6]

QuantConnect.Candlestick.Candlestick ( TradeBar  bar)

Constructor taking candlestick values and time in DateTime format

Parameters
barBar which data will be used to create the candlestick

Definition at line 126 of file Candlestick.cs.

◆ Candlestick() [5/6]

QuantConnect.Candlestick.Candlestick ( DateTime  time,
Bar  bar 
)

Constructor taking candlestick values and time in DateTime format

Parameters
timeCandlestick time in seconds
barBar which data will be used to create the candlestick

Definition at line 136 of file Candlestick.cs.

◆ Candlestick() [6/6]

QuantConnect.Candlestick.Candlestick ( Candlestick  candlestick)

Copy constructor

Parameters
candlestickCandlestick to copy from

Definition at line 145 of file Candlestick.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.Candlestick.ToString ( )

Provides a readable string representation of this instance.

Definition at line 153 of file Candlestick.cs.

◆ Clone()

ISeriesPoint QuantConnect.Candlestick.Clone ( )

Clones this instance

Returns
Clone of this instance

Implements QuantConnect.ISeriesPoint.

Definition at line 162 of file Candlestick.cs.

Here is the call graph for this function:

◆ Update() [1/2]

void QuantConnect.Candlestick.Update ( decimal?  value)

Updates the candlestick with a new value. This will aggregate the OHLC bar

Parameters
valueThe new value

Definition at line 171 of file Candlestick.cs.

◆ Update() [2/2]

void QuantConnect.Candlestick.Update ( decimal  value)

Updates the candlestick with a new value. This will aggregate the OHLC bar

Parameters
valueThe new value

Definition at line 183 of file Candlestick.cs.

Property Documentation

◆ Time

DateTime QuantConnect.Candlestick.Time
getset

The candlestick time

Definition at line 38 of file Candlestick.cs.

◆ LongTime

long QuantConnect.Candlestick.LongTime
get

The candlestick time in seconds since Unix Epoch

Definition at line 44 of file Candlestick.cs.

◆ Open

decimal? QuantConnect.Candlestick.Open
getset

The candlestick open price

Definition at line 55 of file Candlestick.cs.

◆ High

decimal? QuantConnect.Candlestick.High
getset

The candlestick high price

Definition at line 64 of file Candlestick.cs.

◆ Low

decimal? QuantConnect.Candlestick.Low
getset

The candlestick low price

Definition at line 73 of file Candlestick.cs.

◆ Close

decimal? QuantConnect.Candlestick.Close
getset

The candlestick close price

Definition at line 82 of file Candlestick.cs.


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