ParametersReportElement

QuantConnect.Report.ReportElements.ParametersReportElement

ParametersReportElement(
    name: str,
    key: str,
    backtest_configuration: AlgorithmConfiguration,
    live_configuration: AlgorithmConfiguration,
    template: str,
)

Bases: ReportElement

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

Creates a two column table for the Algorithm's Parameters

Parameters:

Name	Type	Description	Default
name	str	Name of the widget	required
key	str	Location of injection	required
backtest_configuration	AlgorithmConfiguration	The configuration of the backtest algorithm	required
live_configuration	AlgorithmConfiguration	The configuration of the live algorithm	required
template	str	HTML template to use	required

name

name: str

Name of this report element

key

key: str

Template key code.

json_key

json_key: str

Normalizes the key into a JSON-friendly key

result

result: Object

Result of the render as an object for serialization to JSON

render

render() -> str

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

Returns:

Type	Description
str	Returns a string representing a HTML two column table.