QuantConnect.Report.ReportElements.ReportElement Class Reference

Common interface for template elements of the report More...

Inheritance diagram for QuantConnect.Report.ReportElements.ReportElement:

Public Member Functions
abstract string	Render ()
	The generated output string to be injected More...

Public Attributes
string	JsonKey => Key.Replace("KPI-", "").Replace("$", "").Replace("{", "").Replace("}", "") .ToLowerInvariant()
	Normalizes the key into a JSON-friendly key More...

Properties
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

Common interface for template elements of the report

Definition at line 21 of file ReportElement.cs.

Member Function Documentation

Render()

abstract string QuantConnect.Report.ReportElements.ReportElement.Render ( )

pure virtual

The generated output string to be injected

Implemented in QuantConnect.Report.ReportElements.SharpeRatioReportElement, QuantConnect.Report.ReportElements.ParametersReportElement, and QuantConnect.Report.ReportElements.EstimatedCapacityReportElement.

Member Data Documentation

JsonKey

string QuantConnect.Report.ReportElements.ReportElement.JsonKey => Key.Replace("KPI-", "").Replace("$", "").Replace("{", "").Replace("}", "") .ToLowerInvariant()

Normalizes the key into a JSON-friendly key

Definition at line 36 of file ReportElement.cs.

Property Documentation

Name

virtual string QuantConnect.Report.ReportElements.ReportElement.Name

getprotected set

Name of this report element

Definition at line 26 of file ReportElement.cs.

Key

virtual string QuantConnect.Report.ReportElements.ReportElement.Key

getprotected set

Template key code.

Definition at line 31 of file ReportElement.cs.

Result

virtual object QuantConnect.Report.ReportElements.ReportElement.Result

getprotected set

Result of the render as an object for serialization to JSON

Definition at line 41 of file ReportElement.cs.

---

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

• Report/ReportElements/ReportElement.cs