Table of Contents

Class CandleDataSeries

Namespace
ATAS.Indicators
Assembly
ATAS.Indicators.dll

Represents a data series of candles. Each element in the series is a Candle.

[DataContract]
[DataSeriesEditor(DataSeriesTypes.Candle)]
public sealed class CandleDataSeries : BaseDataSeries<Candle>, IDataSeries, INotifyPanelPropertyChanged
Inheritance
object
CandleDataSeries
Implements
Extension Methods

Constructors

CandleDataSeries(string)

Initializes a new instance of the CandleDataSeries class with the specified unique and constant data series ID for data serialization.

public CandleDataSeries(string id)

Parameters

id string

The unique and constant data series ID for data serialization.

CandleDataSeries(string, string)

Initializes a new instance of the CandleDataSeries class with the specified unique and constant data series ID for data serialization and unique name.

public CandleDataSeries(string id, string name)

Parameters

id string

The unique and constant data series ID for data serialization.

name string

The unique data series name.

Properties

BorderColor

Gets or sets the color of the data series element border.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "CandleBorderColor", GroupName = "Common", Order = 60)]
public Color BorderColor { get; set; }

Property Value

Color

Count

Gets the number of elements in the data series.

[IgnoreDataMember]
public override int Count { get; }

Property Value

int

Digits

Gets or sets the number of digits after the decimal point.

[DataMember]
[Browsable(false)]
public int Digits { get; set; }

Property Value

int

DownCandleColor

Gets or sets the color of the data series element on a bearish (down) candle.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "DownCandleColor", GroupName = "Common", Order = 50)]
public Color DownCandleColor { get; set; }

Property Value

Color

DrawCandleBorder

Gets or sets whether to draw candle border.

Added in ATAS 8.0.15.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "Drawcandleborder", GroupName = "Common", Order = 75)]
public bool DrawCandleBorder { get; set; }

Property Value

bool

HideOpenCloseLabels

Gets or sets which point of the candle is used as the tooltip anchor.

Added in ATAS 8.0.15.

[Browsable(false)]
public bool HideOpenCloseLabels { get; set; }

Property Value

bool

HideZeroCandles

Gets or sets whether to show current values on the price panel.

Added in ATAS 8.0.15.

[Browsable(false)]
public bool HideZeroCandles { get; set; }

Property Value

bool

IsVisible

Gets a value indicating whether the data series is drawn on the chart; returns Visible.

[Browsable(false)]
public override bool IsVisible { get; }

Property Value

bool

this[int]

Gets or sets the element at the specified index.

public override Candle this[int index] { get; set; }

Parameters

index int

must be a non-negative integer.

Property Value

Candle

An element of type T at the specified index.

Mode

Gets or sets the visualization mode of the data series.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "Mode", GroupName = "Common", Order = 70)]
public CandleVisualMode Mode { get; set; }

Property Value

CandleVisualMode

ScaleIt

Gets or sets whether to scale the data series on the chart.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "ScaleIt", GroupName = "Common", Order = 20)]
public bool ScaleIt { get; set; }

Property Value

bool

ShowCurrentValue

Gets or sets a value indicating whether the close value of the series at the last visible bar is shown on the price axis.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "ShowCurrentValue", GroupName = "Common", Order = 1)]
public bool ShowCurrentValue { get; set; }

Property Value

bool

StringFormat

Gets or sets the price string format used for displaying values.

[DataMember]
[Browsable(false)]
public string StringFormat { get; set; }

Property Value

string

TooltipAnchor

Gets or sets which point of the candle the chart tooltip is anchored to. The default is Close.

Added in ATAS 8.0.15.

[Browsable(false)]
public CandleTooltipAnchor TooltipAnchor { get; set; }

Property Value

CandleTooltipAnchor

UpCandleColor

Gets or sets the color of the data series element on a bullish (up) candle.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "UpCandleColor", GroupName = "Common", Order = 40)]
public Color UpCandleColor { get; set; }

Property Value

Color

ValuesColor

Gets or sets the color of the values text.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "ValuesColor", GroupName = "Common", Order = 65)]
public Color ValuesColor { get; set; }

Property Value

Color

Visible

Gets or sets whether the data series is visible on the chart.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "Visible", GroupName = "Common", Order = 10)]
public bool Visible { get; set; }

Property Value

bool

Methods

Clear()

Clears all elements from the data series.

public override void Clear()