The Backtester class is responsible for performing backtest runs in WL8, and returning information about those runs. This document will focus on the Backtester properties that provide performance information about backtest runs, typically for use in the development of ScoreCard or Performance Visualizer extensions.
The BacktestSettings class contains information about how a backtest was conducted, including the benchmark symbol used, and whether cash interest and dividends were considered.
The BarData class represents a single bar of data, comprised of open, high, low, close and volume values.
The base class for the small icons (glyphs) that are plotted on the chart to represent events like dividends, splits, or candlestick chart patterns. They are the visual depiction of the EventDataPoint instances that are generated by Event Data Providers. The EventProviderBase class can override the GetBarGlyph method to assign custom BarGlyphs for its EventDataPoint instances.
The BarHistory class represents historical price and volume data for a market. When you work with code-based Strategies, you're passed an instance of a BarHistory object in the Initialize, Execute, and other methods. This instance contains the historical data your Strategy should backtest.
BarHistoryCompressor is a static utility class containing methods that let you compress a BarHistory instance from one scale down to a more compressed scale. For example, you can call BarHistoryCompressor.ToWeekly to compress a daily BarHistory into a weekly one.
BarHistorySynchronizer is a static utility class containing the Synchronize method, allowing you to synchronize a BarHistory instance with another time series (either a TimeSeries or BarHistory instance). It is useful when you want to plot time series in one scale on a chart based on another scale (for example, weekly to daily).
Represents an account associated with a connected broker.
Represents an open position held in the associated Broker account.
Contains all of the properties of a visual chart theme, including colors and settings information.
Contains the information for a tooltip to be displayed on the chart.
This UserControl-derived class provides properties and methods that allow it to integrate into the WL8 multiple document interface (MDI) user interface.
Contains the functionality for an object to support configuration. A Configurable object has a Name property, implementing the INamed interface. Its configuration is automatically persisted as a string in WL8's settings file, and is contained in the Configuration parameter. The ConfigurationType property determines whether the configuration string is an object-specific, plain vanilla format, or represents a persisted ParameterList. In the latter case, the object's Parameters property contains its parameters.
The CustomSettingsPanel class allows Historical Data Provider extension authors to define their own configuration user interface for their Provider in the Data Manager.
Contains the information to be displayed in a row in the WL8 Data Panel. If you are building a Data Panel ScoreCard Extension, you'll create instances of DataPanelItem objects and add them to the List returned in the GetItems method.
The DataSet class represents a DataSet in WL8, either created by the user using the New DataSet Wizard, or from a DataSet Provider. DataSet Providers can return instances of classes that derive from DataSet, in addition to instances of plain vanilla DataSets themselves. Therefore, the DataSets class contains several properties and methods that a DataSet Provider author can override when creating a derived class.
Represents a range of date/time values.
Covers a list of DateTime extension methods that assist with typical trading functions related to date and time. Call these methods like any other DateTime method using the method syntax. The first parameter, always this DateTime, specifies the type that the method operates on. See the examples for usage details.
Represents a component line in a chart drawing object.
These are the various enumerated types used throughout the WealthLab .NET Framework.
Contains a list of EventDataPoint instances which were read from persistent storage, and passed to an Event Data Provider's ConvertEventItems method.
The EventDataPoint class represents a single piece of event data, such as a fundamental data item (dividend, split, earlings), analyst rating, or chart pattern. WealthLab supports several Event Data Providers, both included out of the box and available via extensions. Each provider supplies its own set of historical event data.
The Handle class is used to represent the handles of a chart drawing object. The user can typically grab a handle and drag it across the chart with the mouse.
A static class that converts BarHistory data into a Heikin-Ashi version.
Represents a point of data on a WL8 chart.
The HistoryScale class represents a data time scale, for example daily, weekly, or 5-minute intraday scales.
The IBulkUpdateHost interface is used to communicate back to WL8 during a Provider Update, and is part of the Historical Data Provider extension API.
This interface allows WL8 to communicate with a chart in a ChildWindow instance. The WealthLab.WPF Chart class implements IChart. If you are implementing a ChildWindow in a Wealth-Lab extension, and it contains a chart, you can override the Chart property to return an instance of this interface.
Create a class derived from WPF UserControl, and implement this interface to provide a Custom Settings Editor Panel for a WL8 component such as a Historical Data Provider or a Broker Provider. In order for your component to locate and use the Custom Editor, you'll also need to create a class derived from ObjectEditorBase, with the same Name as your component, and return an instance of the Editor in that class' GetCustomSettingsEditor method.
The ICustomSettingsHost interface lets a CustomSettingsPanel created by a Historical Data Provider communicate changes back to the WL8 Data Manager.
The IHost interface is used to communicate various aspects of the WL8 environment to Strategies and WL8 Extensions. You can always get the singleton instance of the IHost interface by accessing WLHost.Instance.
The IMetricsReportHost interface is used in the ScoreCard extension API, and helps ScoreCards define a layout for their performance reports. It is passed to the ScoreCard as a parameter of the LayoutMetricsReport method.
IndicatorBase is the base class for indicators in WealthLab. It is derived from TimeSeries, and basically contains a list of floating point double Values keyed off a list of DateTimes. The class contains additional methods and properties that let it work with the indicator management subsystem of WealthLab, and will be most useful for developers creating their own custom indicators.
The IOptimizationHost interface allows Optimization Visualizers to communicate back to their host Optimization (Strategy) window.
The IOptimizerHost instance allows Optimizers (classes derived from the OptimizerBase base class) to communicate their progress back to their host.
The IStrategyHost interface allows Strategy Evolver Visualizers to communicate back to their host Strategy Evolver window.
The IStrategyHost interface allows Performance Visualizers to communicate back to their host Strategy window.
This interface provides properties and methods that let you hook into the WL8 window that is hosting a child window, typically created by an extension.
LineUtils is a static class of function that aid with projecting trendlines.
Represents a drawing object (such as a trend line, Fibonacci retracement, or note) that was placed on the chart. WL8 saves manually drawn chart objects by symbol and HistoryScale (Daily, Weekly, etc).
The MarketDetails class contains information about a market, such as the US Stock Market, or the Cryptocurrency markets. Historical Data Providers in WealthLab can create MarketDetails instances and assign them to symbols, or you can make such assignments yourself using the Markets & Symbols tool.
The MarketHours class represents the open and close times of a market, and is used to represent market trading hours in the MarketDetails class.
MarketManager is a static utility class that manages information about markets and symbols in WealthLab. It contains a list of MarketDetail instances in the Markets property. This contains information about the various markets such as US stocks, Forex, or Cryptocurrencies. It also contains a list of SymbolInfo instances in the Symbols property that contain information about symbols, such as their associated market, margin, and point values.
Contains the set of performance metrics for a particular optimization run, and other details about the run.
A List of OptimizationResult instances that contains some helper methods.
Base class for StrategyOptimizer and WFOOptimizer.
The OptionGreek class contains fields to hold a single set of greeks for an option symbol. Not all fields will be used by every historical providers that support options.
OptionsHelper is a static class with methods to assist with converting and parsing option symbols with different formast. The primary method is C2Symbol which converts an option symbol of any format to the Collective2 option symbol format.
OptionSynthetic is a static class with methods to obtain the calculated BarHistory of a synthetic option contract as well as OptionGreek calculations using the Black-Scholes model. An estimate of implied volatility is required as an input. The calculations are only truly representative of actual option pricing if the implied volatility is known.
The Parameter class represents a configurable parameter, and it most often used in C# Coded Strategies and custom indicators (derived from IndicatorBase). Each Parameter instance has a Name, a Type (see ParameterTypes in the Enums reference) and a default Value.
The ParameterList class descends from List
The PeakTrough class represents a peak or trough that was detected in time series data by the PeakTroughCalculator utility class.
The PeakTroughCalculator is a utility class the calculates peaks and troughs in the source time series data. Peaks and troughs are calculated by observing when the data moves by a certain reversal amount, which can be expressed as either percent or point value. The result is a list of PeakTrough objects available via the PeakTroughs property.
PenBrushFactory is a static class that can return WPF Pen and Brush objects that are styled to the currently selected WL8 Theme. Additionally, the Pens and Brushes are cached so that multiple requests for the same objects will not incur unnecessary processing.
The base class for any object that can be plotted on the WL8 Chart.
The Position class represents a long (result of a buy order) or short (result of a sell short order) position that was generated by the backtester.
A List containing Position instances, with additional utility members.
Represents the position sizing that was established for a backtest.
Maps price data into a 2D grid, and allows you to compare grids to see how well different slices of the price data match.
Derived from WPF UserControl, serves as a base class for WL8 Visualizers.
Contains the information saved from an optimization run.
The SettingsManager can manage a set of values of varying type that are keyed by strings. It has a built-in mechanism to automatically save its contents to a file on the user's local machine. SettingsManager is thread-safe.
The Strategy class holds the strategy code and other metadata information about the strategy. The Backtester class will have an instance of the Strategy being tested, and it may be useful to access some Strategy properties, for example, to ensure that the intended PositionSize is selected or to find the Benchmark symbol.
Contains the set of performance metrics for a particular Strategy Evolver run, and other details about the run.
A List of StrategyEvolverResult instances that contains some helper properties and methods. The list will contain instances for all generations of an Evolver run. It will contain the instances of both the Strategies that made it through the selected Evolver Filter, and ones that were filtered out. Since each Evolver run typically includes 20 candiate Strategies, if there were 10 generations processed then the list would contain 200 StrategyEvolverResult entries.
Executes optimization runs for Optimizers. Optimizer extensions call the ExecuteOptimizationRun method to execute a run, and Optimization Visualizers access the Results from this class to represent optimization performance results.
The SymbolInfo class represents information about a single tradable instrument, keyed by the Symbol property. If Futures Mode is enabled in WealthLab, the Margin, PointValue, and other futures related properties are factored into backtesting.
TabPage is a user interface class derived from the WPF UserControl. It contains additional properties and methods that allow it to be installed as a new tab page in the WL8 Preferences tool. A custom WL8 Extension (WL8ExtensionBase) can override its PreferencePages property to return instances that are added to the Preferences tool tab control.
The Tick class represents a tick, or single trade, in a market data stream.
The TimeSeries class manages a series of numeric double values keyed off a list of DateTimes. The two primary properties of TimeSeries are:
TimeSeriesBase is an abstract class that contains the plumbing for working with a time series keyed off a list of DateTimes. It exposes this list through the DateTimes property, which is a List<DateTime>. Two important concrete classes derive from TimeSeriesBase:
TimeSeriesCompressor is a static utility class containing methods that let you compress a TimeSeries instance from one scale down to a more compressed scale. For example, you can call TimeSeriesCompressor.ToWeekly to compress a daily TimeSeries into a weekly one.
TimeSeriesSynchronizer is a static utility class containing the Synchronize method, allowing you to synchronize a TimeSeries instance with another time series (either a TimeSeries or BarHistory instance). It is useful when you want to plot time series in one scale on a chart based on another scale (for example, weekly to daily).
The Transaction class represents the result of an order (buy, sell, sell short, or cover short) that was placed either during a simulated backtest, or in the WealthLab Order Manager.
The TrendLine class represents a trend line within a time series data source. It expresses two points via the properties Index1, Value1 and Index2, Value2. The PeakTroughCalculator contains methods that return TrendLine instances based on the generated peaks and troughs.
UserStrategyBase represents a trading Strategy in WealthLab. When you work with C# Code-Based Strategies, you are actually coding a custom class that is derived from UserStrategyBase. The class provides properties and methods that let you control the logic of the trading system, including placing orders and examining the current state of the system.
Generates a Volume Profile, which is a distribution of horizontal lines (represented by instances of the VolumeProfileItem class) distributed along the Y-axis of the chart. Each Volume Profile line has a horizontal length determined by the total volume that ocurred within its min/max range using a specified lookback period.
Represents a single horizontal line in a Volume Pofile. The VolumeProfile class maintains a list of VolumeProfileInstances in its Items property.
Executes walk-forward optimizations (WFO). This class compiles the results of the WFO for use by Optimization Visualizers.
Contains the performance results of a single walk-forward optimization run, and also other information about that run.
Represents a color in a platform-independent way.
Represents a font in a platform-independent way.