Class CandlestickPlot

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

public class CandlestickPlot : IPlottable

Inheritance

object

CandlestickPlot

Implements

IPlottable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

DataSourceUtilities.BinarySearch<T, TList>(TList, int, int, T, IComparer<T>?)

DataSourceUtilities.GetClosestIndex<TValue, TList>(TList, TValue, IndexRange, IComparer<TValue>?)

Constructors

CandlestickPlot(IOHLCSource)

public CandlestickPlot(IOHLCSource data)

Parameters

data IOHLCSource

Fields

SymbolWidth

Fractional width of the candle symbol relative to its time span

public double SymbolWidth

Field Value

double

Properties

Axes

This object performs coordinate/pixel translation at render time based on the latest data area. It stores the axes to use for this plottable and also the data area (in pixels) updated just before each render. If this object is null it will be constructed using the default X and Y axes at render time.

public IAxes Axes { get; set; }

Property Value

IAxes

Data

public IOHLCSource Data { get; }

Property Value

IOHLCSource

FallingColor

public Color FallingColor { set; }

Property Value

Color

FallingFillStyle

public FillStyle FallingFillStyle { get; }

Property Value

FillStyle

FallingLineStyle

public LineStyle FallingLineStyle { get; }

Property Value

LineStyle

IsVisible

Toggles whether this plottable is shown and contributes to the automatic axis limit detection. The calling method will check this variable (it does not need to be checked inside the Render method).

public bool IsVisible { get; set; }

Property Value

bool

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

RisingColor

public Color RisingColor { set; }

Property Value

Color

RisingFillStyle

public FillStyle RisingFillStyle { get; }

Property Value

FillStyle

RisingLineStyle

public LineStyle RisingLineStyle { get; }

Property Value

LineStyle

Sequential

X position of candles is sourced from the OHLC's DateTime by default. If this option is enabled, X position will be an ascending integers starting at 0 with no gaps.

public bool Sequential { get; set; }

Property Value

bool

Methods

GetAxisLimits()

Return the 2D area (in coordinate space) occupied by the data contained in this plottable

public AxisLimits GetAxisLimits()

Returns

AxisLimits

GetOhlcNearX(double)

public (int index, OHLC ohlc)? GetOhlcNearX(double x)

Parameters

x double

Returns

(int index, OHLC ohlc)?

GetPriceRangeInView()

public CoordinateRange GetPriceRangeInView()

Returns

CoordinateRange

Render(RenderPack)

Draw the data from this plottable into the data area defined in the Axes. By default the surface is already clipped to the data area, but this can be cleared inside the plottable.

public virtual void Render(RenderPack rp)

Parameters

rp RenderPack