Table of Contents

Class BaseDataSeries<T>

Namespace
ATAS.Indicators
Assembly
ATAS.Indicators.dll

Base generic data series class providing common functionality.

[DataContract]
public abstract class BaseDataSeries<T> : IDataSeries, INotifyPanelPropertyChanged

Type Parameters

T

Type of the data series.

Inheritance
object
BaseDataSeries<T>
Implements
Derived
Extension Methods

Constructors

BaseDataSeries(DataSeriesType)

Initializes a new instance of the BaseDataSeries<T> class of the specified type without setting its ID, name or RenderId.

protected BaseDataSeries(DataSeriesType type)

Parameters

type DataSeriesType

The type of the data series.

BaseDataSeries(string, DataSeriesType)

Initializes a new instance of the BaseDataSeries<T> class whose name equals its ID.

protected BaseDataSeries(string id, DataSeriesType type)

Parameters

id string

The unique and constant data series ID used for serialization; also used as the name.

type DataSeriesType

The type of the data series.

Exceptions

ArgumentNullException

id is null.

BaseDataSeries(string, string, DataSeriesType)

Initializes a new instance of the BaseDataSeries<T> class with the specified ID and name.

protected BaseDataSeries(string id, string name, DataSeriesType type)

Parameters

id string

The unique and constant data series ID used for serialization.

name string

The name of the data series.

type DataSeriesType

The type of the data series.

Exceptions

ArgumentNullException

id or name is null.

Properties

Count

Gets the number of elements in the data series.

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

Property Value

int

DescriptionKey

Get or sets the description of the data series.

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

Property Value

string

DrawAbovePrice

Gets or sets whether the data series should be drawn above candles of chart.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "DrawAbovePrice", Description = "DrawAbovePriceDescription", Order = 100)]
public bool DrawAbovePrice { get; set; }

Property Value

bool

Id

Gets or sets the unique and constant data series ID for data serialization.

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

Property Value

string

IgnoredByAlerts

Gets or sets a value indicating whether the data series should be ignored by alerts.

[DataMember]
[Display(ResourceType = typeof(Strings), Name = "IgnoredByAlerts", Description = "IgnoredByAlertsDescription", Order = 100)]
public bool IgnoredByAlerts { get; set; }

Property Value

bool

IsHidden

Gets or sets a value indicating whether the data series properties should be hidden from the settings window.

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

Property Value

bool

IsVisible

Gets a value indicating whether the data series is drawn on the chart. The base implementation returns true; derived series override it according to their visibility settings.

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

Property Value

bool

this[int]

Gets or sets the element at the specified index.

public abstract T this[int index] { get; set; }

Parameters

index int

must be a non-negative integer.

Property Value

T

An element of type T at the specified index.

Name

Gets or sets the name of the data series.

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

Property Value

string

RenderId

Gets the identifier the chart renderer uses to cache scaled data of this series instance. A new GUID is assigned by the constructors that take an ID; it is not serialized.

[Browsable(false)]
public string RenderId { get; init; }

Property Value

string

ResetAlertsOnNewBar

Gets or sets a value indicating whether alerts should be reset on a new bar.

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

Property Value

bool

ShowNameOnMouseOver

Gets or sets a value indicating whether the name of the data series should be shown on mouseover.

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

Property Value

bool

ShowTooltip

Gets or sets a value indicating whether the data series tooltip should be shown.

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

Property Value

bool

Type

Gets the type of the data series from the enumeration.

[Browsable(false)]
[DataMember]
public DataSeriesType Type { get; }

Property Value

DataSeriesType

UseMinimizedModeIfEnabled

Gets or sets a value indicating whether the minimized mode should be used if enabled.

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

Property Value

bool

ValueCurrency

Not in ATAS 8.0.15 yet: available from the next version.

[Browsable(false)]
public string? ValueCurrency { get; set; }

Property Value

string

Methods

Clear()

Clears all elements from the data series.

public virtual void Clear()

RaiseChanged(int)

Raises the Changed event for the specified bar.

protected void RaiseChanged(int bar)

Parameters

bar int

The index of the bar whose value changed.

RaisePanelPropertyChanged(string)

Raises the PanelPropertyChanged event for the specified property.

protected virtual void RaisePanelPropertyChanged(string propertyName)

Parameters

propertyName string

The name of the property that changed.

RaisePropertyChanged(string)

Raises the PropertyChanged event for the specified property.

protected virtual void RaisePropertyChanged(string propertyName)

Parameters

propertyName string

The name of the property that changed.

ToString()

Returns an empty string.

public override string ToString()

Returns

string

string.Empty.

Events

Changed

Added in ATAS 8.0.15.

public event Action<int>? Changed

Event Type

Action<int>

PanelPropertyChanged

Added in ATAS 8.0.15.

public event PropertyChangedEventHandler? PanelPropertyChanged

Event Type

PropertyChangedEventHandler

PropertyChanged

Added in ATAS 8.0.15.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler