Lean  $LEAN_TAG$
QuantConnect.Chart Class Reference

Single Parent Chart Object for Custom Charting More...

Public Member Functions

 Chart ()
 Default constructor for chart: More...
 
 Chart (string name, ChartType type=ChartType.Overlay)
 Chart Constructor: More...
 
 Chart (string name)
 Constructor for a chart More...
 
void AddSeries (Series series)
 Add a reference to this chart series: More...
 
Series TryAddAndGetSeries (string name, SeriesType type, int index, string unit, Color color, ScatterMarkerSymbol symbol, bool forceAddNew=false)
 Gets Series if already present in chart, else will add a new series and return it More...
 
Chart GetUpdates ()
 Fetch a chart with only the updates since the last request, Underlying series will save the index position. More...
 
Chart Clone ()
 Return a new instance clone of this object More...
 

Public Attributes

string Name = ""
 Name of the Chart:
 
ChartType ChartType = ChartType.Overlay
 Type of the Chart, Overlayed or Stacked.
 
Dictionary< string, SeriesSeries = new Dictionary<string, Series>()
 List of Series Objects for this Chart:
 

Detailed Description

Single Parent Chart Object for Custom Charting

Definition at line 29 of file Chart.cs.

Constructor & Destructor Documentation

◆ Chart() [1/3]

QuantConnect.Chart.Chart ( )

Default constructor for chart:

Definition at line 44 of file Chart.cs.

Here is the caller graph for this function:

◆ Chart() [2/3]

QuantConnect.Chart.Chart ( string  name,
ChartType  type = ChartType.Overlay 
)

Chart Constructor:

Parameters
nameName of the Chart
typeType of the chart

Definition at line 52 of file Chart.cs.

◆ Chart() [3/3]

QuantConnect.Chart.Chart ( string  name)

Constructor for a chart

Parameters
nameString name of the chart

Definition at line 63 of file Chart.cs.

Member Function Documentation

◆ AddSeries()

void QuantConnect.Chart.AddSeries ( Series  series)

Add a reference to this chart series:

Parameters
seriesChart series class object

Definition at line 73 of file Chart.cs.

◆ TryAddAndGetSeries()

Series QuantConnect.Chart.TryAddAndGetSeries ( string  name,
SeriesType  type,
int  index,
string  unit,
Color  color,
ScatterMarkerSymbol  symbol,
bool  forceAddNew = false 
)

Gets Series if already present in chart, else will add a new series and return it

Parameters
nameName of the series
typeType of the series
indexIndex position on the chart of the series
unitUnit for the series axis
colorColor of the series
symbolSymbol for the marker in a scatter plot series
forceAddNewTrue will always add a new Series instance, stepping on existing if any

Definition at line 96 of file Chart.cs.

◆ GetUpdates()

Chart QuantConnect.Chart.GetUpdates ( )

Fetch a chart with only the updates since the last request, Underlying series will save the index position.

Returns

Definition at line 118 of file Chart.cs.

Here is the call graph for this function:

◆ Clone()

Chart QuantConnect.Chart.Clone ( )

Return a new instance clone of this object

Returns

Definition at line 139 of file Chart.cs.

Here is the call graph for this function:

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