Class PlotInstruction

Namespace

Balsam

Assembly

Balsam.Backtester.dll

Encapsulates instructions to plot a series on a chart.

public class PlotInstruction

Inheritance

object

PlotInstruction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Excel.ExportToExcel(object)

Clipboard.CopyToClipboard(object)

Fields

PlotStops

Plot stops.

public static readonly PlotInstruction PlotStops

Field Value

PlotInstruction

Properties

ChartType

Gets/sets the type of chart. Common types include Line, Point, and Column. Use Stock for OHLC bar charts or Candlestick for candle charts. Defaults to Line.

public string ChartType { get; set; }

Property Value

string

Color

Gets/sets the color of the plot.

public Color Color { get; set; }

Property Value

Color

IsLogarithmic

Gets/sets whether the y-axis should be logarithmic.

public bool IsLogarithmic { get; set; }

Property Value

bool

LabelFormat

Gets/sets the format of the Y axis label.

public string LabelFormat { get; set; }

Property Value

string

LineStyle

Gets/sets the line style of the plot. Common values are Solid, Dash, or Dot.

public string LineStyle { get; set; }

Property Value

string

Pane

Gets/sets the pane in which to plot. 0 is primary pane. Numbers greater than 0 will create a new pane.

public int Pane { get; set; }

Property Value

int

PaneSize

Gets/sets the size of the pane from 0 to 100.

public float PaneSize { get; set; }

Property Value

float

RangeHigh

Gets/sets the high series to be used for a range plot. Only Timeseries and Integerseries are supported.

public ISeries RangeHigh { get; set; }

Property Value

ISeries

RangeLow

Gets/sets the low series to be used for a range plot. Only Timeseries and Integerseries are supported.

public ISeries RangeLow { get; set; }

Property Value

ISeries

Series

Gets/sets the series to be plotted.

public ISeries Series { get; set; }

Property Value

ISeries

Text

Gets/sets the text for a horizontal or vertical line.

public string Text { get; set; }

Property Value

string

TextAlignment

Gets/sets the alignment of text for a horizontal or vertical line. Valid values are 'Near', 'Center' and 'Far'.

public string TextAlignment { get; set; }

Property Value

string

Width

Gets/sets the width of the plot.

public int Width { get; set; }

Property Value

int

XValue

Gets/sets the date for a vertical line.

public DateTime? XValue { get; set; }

Property Value

DateTime?

YValue

Gets/sets the Y value for a horizontal line.

public double? YValue { get; set; }

Property Value

double?