Search Framework:
IMetricsReportHost
Namespace: WealthLab.Backtest
Parent:

The IMetricsReportHost interface is used by ScoreCard extensions to define the layout of their performance metrics reports. An instance of this interface is passed to the ScoreCard's LayoutMetricsReport method, where you can add metric values, headers, and separators to the report.

Members
AddHeader
void AddHeader(string header)

Adds a header to the performance metrics report, using the text specified in header.


AddMetricDateTime
void AddMetricDateTime(string itemName, string label = null)

Adds a DateTime metric to the performance metrics report. Pass the Name of the performance metric in itemName. Optionally specify label to display a label other than the metric's itemName.


AddMetricDouble
void AddMetricDouble(string itemName, bool isColorCoded, bool isPctFmt, int decimals = 2, string label = null)

Adds a double metric to the performance metrics report. Pass the Name of the performance metric in itemName. If isColorCoded is true, the value is displayed in green when it is greater than or equal to zero, and red when it is less than zero. If isPctFmt is true, the value is formatted as a percentage. Use decimals to specify the number of decimal places to display. The default is 2. Optionally specify label to display a label other than the metric's itemName.


AddMetricInt
void AddMetricInt(string itemName, string label = null)

Adds an int metric to the performance metrics report. Pass the Name of the performance metric in itemName. Optionally specify label to display a label other than the metric's itemName.


AddMetricString
void AddMetricString(string itemName, string label = null)

Adds a string metric to the performance metrics report. Pass the Name of the performance metric in itemName. Optionally specify label to display a label other than the metric's itemName.


AddSeparator
void AddSeparator()

Adds a blank line, or separator, to the performance metrics report.