Lean  $LEAN_TAG$
QuantConnect.ChartPoint Class Reference

Single Chart Point Value Type for QCAlgorithm.Plot(); More...

Inheritance diagram for QuantConnect.ChartPoint:
[legend]

Public Member Functions

 ChartPoint ()
 Default constructor. Using in SeriesSampler. More...
 
 ChartPoint (long xValue, decimal? yValue)
 Constructor that takes both x, y value pairs More...
 
 ChartPoint (DateTime time, decimal? value)
 Constructor that takes both x, y value pairs More...
 
 ChartPoint (ChartPoint point)
 Cloner Constructor:
 
override string ToString ()
 Provides a readable string representation of this instance. More...
 
virtual ISeriesPoint Clone ()
 Clones this instance More...
 

Public Attributes

long X => x
 Shortcut for x for C# naming conventions More...
 
decimal? Y => y
 Shortcut for y for C# naming conventions More...
 

Properties

DateTime Time [get, set]
 Time of this chart series point More...
 
long x [get, set]
 Chart point time More...
 
decimal? y [get, set]
 Chart point value More...
 
- Properties inherited from QuantConnect.ISeriesPoint
DateTime Time [get, set]
 Time of this chart series point More...
 

Detailed Description

Single Chart Point Value Type for QCAlgorithm.Plot();

Definition at line 26 of file ChartPoint.cs.

Constructor & Destructor Documentation

◆ ChartPoint() [1/3]

QuantConnect.ChartPoint.ChartPoint ( )

Default constructor. Using in SeriesSampler.

Definition at line 97 of file ChartPoint.cs.

Here is the caller graph for this function:

◆ ChartPoint() [2/3]

QuantConnect.ChartPoint.ChartPoint ( long  xValue,
decimal?  yValue 
)

Constructor that takes both x, y value pairs

Parameters
xValueX value often representing a time in seconds
yValueY value

Definition at line 104 of file ChartPoint.cs.

◆ ChartPoint() [3/3]

QuantConnect.ChartPoint.ChartPoint ( DateTime  time,
decimal?  value 
)

Constructor that takes both x, y value pairs

Parameters
timeThis point time
valueY value

Definition at line 116 of file ChartPoint.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.ChartPoint.ToString ( )

Provides a readable string representation of this instance.

Definition at line 134 of file ChartPoint.cs.

◆ Clone()

virtual ISeriesPoint QuantConnect.ChartPoint.Clone ( )
virtual

Clones this instance

Returns
Clone of this instance

Implements QuantConnect.ISeriesPoint.

Reimplemented in QuantConnect.ScatterChartPoint.

Definition at line 143 of file ChartPoint.cs.

Here is the call graph for this function:

Member Data Documentation

◆ X

long QuantConnect.ChartPoint.X => x

Shortcut for x for C# naming conventions

Definition at line 86 of file ChartPoint.cs.

◆ Y

decimal? QuantConnect.ChartPoint.Y => y

Shortcut for y for C# naming conventions

Definition at line 92 of file ChartPoint.cs.

Property Documentation

◆ Time

DateTime QuantConnect.ChartPoint.Time
getset

Time of this chart series point

Definition at line 37 of file ChartPoint.cs.

◆ x

long QuantConnect.ChartPoint.x
getset

Chart point time

Lower case for javascript encoding simplicity

Definition at line 54 of file ChartPoint.cs.

◆ y

decimal? QuantConnect.ChartPoint.y
getset

Chart point value

Lower case for javascript encoding simplicity

Definition at line 71 of file ChartPoint.cs.


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