Table of Contents

Class ValueDataSeries

Namespace
ATAS.Indicators
Assembly
ATAS.Indicators.dll

Represents a data series of decimal values, each element is a decimal.

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

Constructors

ValueDataSeries(string)

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

public ValueDataSeries(string id)

Parameters

id string

The unique and constant data series ID for data serialization.

ValueDataSeries(string, string)

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

public ValueDataSeries(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

Color

Gets or sets the color for drawing the value data series.

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

Property Value

Color

Colors

Allows to change color per bar. Color value will be used for all bars by default.

[Browsable(false)]
public ValueDataSeries.BarColors Colors { get; }

Property Value

ValueDataSeries.BarColors

Count

Gets the number of elements in the data series.

[Browsable(false)]
[IgnoreDataMember]
public override int Count { get; }

Property Value

int

Digits

Gets or sets the number of digits after the decimal point for formatting the value data series.

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

Property Value

int

IsVisible

Gets a value indicating whether the data series is drawn on the chart: false when VisualType is Hide or OnlyValueOnAxis.

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

Property Value

bool

this[int]

Gets or sets the element at the specified index.

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

Parameters

index int

must be a non-negative integer.

Property Value

decimal

An element of type T at the specified index.

LineDashStyle

Gets or sets the line dash style for drawing the value data series.

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

Property Value

LineDashStyle

RenderColor

Gets or sets the color the series is drawn with, as System.Drawing.Color. Setting Color updates it; it is also the color of the bars that Colors does not override.

[Browsable(false)]
public Color RenderColor { get; set; }

Property Value

Color

ScaleIt

Gets or sets whether to use scaling for the value data series.

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

Property Value

bool

ShowCurrentValue

Gets or sets whether to show the current value on the price panel for the value data series.

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

Property Value

bool

ShowOnlyNonZeroLabels

Always draw last non-zero value on price axis.

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

Property Value

bool

ShowZeroValue

Gets or sets whether to show zero value on price axis for the value data series.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "ShowZeroValue", GroupName = "Common", Description = "ShowZeroValueDescription", Order = 80)]
public bool ShowZeroValue { get; set; }

Property Value

bool

StringFormat

Gets or sets the price string format for formatting the value data series.

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

Property Value

string

ValuesColor

Gets or sets the values text color for the value data series.

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

Property Value

Color

VisualType

Gets or sets the visual mode for drawing the value data series.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "VisualType", GroupName = "Common", Description = "ValueDataSeriesVisualTypeDescription", Order = 30)]
public VisualMode VisualType { get; set; }

Property Value

VisualMode

Width

Gets or sets the width for drawing the value data series.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "Width", GroupName = "Common", Description = "WidthDataSeriesDescription", Order = 60)]
public int Width { get; set; }

Property Value

int

ZeroValue

Value of zero line for 'Histogram' mode

[Browsable(false)]
public decimal ZeroValue { get; set; }

Property Value

decimal

Methods

Clear()

Clears all elements from the data series.

public override void Clear()

IsThisPointOfStartBar(int)

Checks if the specified bar index is a point of start for a line in the value data series.

public bool IsThisPointOfStartBar(int bar)

Parameters

bar int

The index of the bar to check.

Returns

bool

True if the specified bar index is a point of start for a line; otherwise, false.

LastNonZeroValue(int)

Gets the last non-zero value in the range from 0 to the specified bar.

public decimal LastNonZeroValue(int bar)

Parameters

bar int

The index of the last bar of the range.

Returns

decimal

The last non-zero value within the specified range of bars. If no non-zero value is found, the value at the starting bar index is returned.

RemovePointOfEndLine(int)

Removes the specified bar index as a point of end for a line in the value data series.

public void RemovePointOfEndLine(int bar)

Parameters

bar int

The index of the bar to remove as a point of end.

SetPointOfEndLine(int)

Sets the specified bar index as a point of end for a line in the value data series.

public void SetPointOfEndLine(int bar)

Parameters

bar int

The index of the bar to set as a point of end.