Lean  $LEAN_TAG$
QuantConnect.ScatterChartPoint Class Reference

A chart point for a scatter series plot More...

Inheritance diagram for QuantConnect.ScatterChartPoint:
[legend]

Public Member Functions

 ScatterChartPoint ()
 Creates a new empty instance More...
 
 ScatterChartPoint (long time, decimal? value, string tooltip=null)
 Creates a new instance at the specified time and value More...
 
 ScatterChartPoint (DateTime time, decimal? value, string tooltip=null)
 Creates a new instance at the specified time and value More...
 
override ISeriesPoint Clone ()
 Clones this instance More...
 
- Public Member Functions inherited from QuantConnect.ChartPoint
 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...
 

Properties

string Tooltip [get, set]
 A summary of this point for the tooltip More...
 
- Properties inherited from QuantConnect.ChartPoint
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...
 

Additional Inherited Members

- Public Attributes inherited from QuantConnect.ChartPoint
long X => x
 Shortcut for x for C# naming conventions More...
 
decimal? Y => y
 Shortcut for y for C# naming conventions More...
 

Detailed Description

A chart point for a scatter series plot

Definition at line 25 of file ScatterChartPoint.cs.

Constructor & Destructor Documentation

◆ ScatterChartPoint() [1/3]

QuantConnect.ScatterChartPoint.ScatterChartPoint ( )

Creates a new empty instance

Definition at line 36 of file ScatterChartPoint.cs.

◆ ScatterChartPoint() [2/3]

QuantConnect.ScatterChartPoint.ScatterChartPoint ( long  time,
decimal?  value,
string  tooltip = null 
)

Creates a new instance at the specified time and value

Definition at line 43 of file ScatterChartPoint.cs.

◆ ScatterChartPoint() [3/3]

QuantConnect.ScatterChartPoint.ScatterChartPoint ( DateTime  time,
decimal?  value,
string  tooltip = null 
)

Creates a new instance at the specified time and value

Definition at line 51 of file ScatterChartPoint.cs.

Member Function Documentation

◆ Clone()

override ISeriesPoint QuantConnect.ScatterChartPoint.Clone ( )
virtual

Clones this instance

Returns
Clone of this instance

Reimplemented from QuantConnect.ChartPoint.

Definition at line 60 of file ScatterChartPoint.cs.

Property Documentation

◆ Tooltip

string QuantConnect.ScatterChartPoint.Tooltip
getset

A summary of this point for the tooltip

Definition at line 31 of file ScatterChartPoint.cs.


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