Lean  $LEAN_TAG$
QuantConnect.Report.ReportElements.ParametersReportElement Class Reference

Class for creating a two column table for the Algorithm's Parameters in a report More...

Inheritance diagram for QuantConnect.Report.ReportElements.ParametersReportElement:
[legend]

Public Member Functions

 ParametersReportElement (string name, string key, AlgorithmConfiguration backtestConfiguration, AlgorithmConfiguration liveConfiguration, string template)
 Creates a two column table for the Algorithm's Parameters More...
 
override string Render ()
 Generates a HTML two column table for the Algorithm's Parameters More...
 

Additional Inherited Members

- Public Attributes inherited from QuantConnect.Report.ReportElements.ReportElement
string JsonKey => Key.Replace("KPI-", "").Replace("$", "").Replace("{", "").Replace("}", "") .ToLowerInvariant()
 Normalizes the key into a JSON-friendly key More...
 
- Properties inherited from QuantConnect.Report.ReportElements.ReportElement
virtual string Name [get, protected set]
 Name of this report element More...
 
virtual string Key [get, protected set]
 Template key code. More...
 
virtual object Result [get, protected set]
 Result of the render as an object for serialization to JSON More...
 

Detailed Description

Class for creating a two column table for the Algorithm's Parameters in a report

Definition at line 25 of file ParametersReportElement.cs.

Constructor & Destructor Documentation

◆ ParametersReportElement()

QuantConnect.Report.ReportElements.ParametersReportElement.ParametersReportElement ( string  name,
string  key,
AlgorithmConfiguration  backtestConfiguration,
AlgorithmConfiguration  liveConfiguration,
string  template 
)

Creates a two column table for the Algorithm's Parameters

Parameters
nameName of the widget
keyLocation of injection
backtestConfigurationThe configuration of the backtest algorithm
liveConfigurationThe configuration of the live algorithm
templateHTML template to use

Definition at line 38 of file ParametersReportElement.cs.

Member Function Documentation

◆ Render()

override string QuantConnect.Report.ReportElements.ParametersReportElement.Render ( )
virtual

Generates a HTML two column table for the Algorithm's Parameters

Returns
Returns a string representing a HTML two column table

Implements QuantConnect.Report.ReportElements.ReportElement.

Definition at line 63 of file ParametersReportElement.cs.


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