Table of Contents

Class CandleSeries

Namespace
StockSharp.Algo.Candles
Assembly
StockSharp.BusinessEntities.dll

Candles series.

public class CandleSeries : NotifiableObject, IPersistable
Inheritance
CandleSeries
Implements
IPersistable
Extension Methods

Constructors

CandleSeries()

Initializes a new instance of the CandleSeries.

public CandleSeries()

CandleSeries(Type, Security, object)

Initializes a new instance of the CandleSeries.

public CandleSeries(Type candleType, Security security, object arg)

Parameters

candleType Type

The candle type.

security Security

The instrument to be used for candles formation.

arg object

The candle formation parameter. For example, for TimeFrameCandle this value is TimeFrame.

Properties

AllowBuildFromSmallerTimeFrame

Allow build candles from smaller timeframe.

[Display(ResourceType = typeof(LocalizedStrings), Name = "SmallerTimeFrame", Description = "SmallerTimeFrameDesc", GroupName = "General", Order = 5)]
public bool AllowBuildFromSmallerTimeFrame { get; set; }

Property Value

bool

Remarks

Available only for TimeFrameCandle.

Arg

The candle formation parameter. For example, for TimeFrameCandle this value is TimeFrame.

[Browsable(false)]
public object Arg { get; set; }

Property Value

object

BuildCandlesField

Extra info for the BuildCandlesFrom.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Field", Description = "Level1Field", GroupName = "Build", Order = 22)]
public Level1Fields? BuildCandlesField { get; set; }

Property Value

Level1Fields?

BuildCandlesFrom

Which market-data type is used as a source value.

[Browsable(false)]
[Obsolete("Use BuildCandlesFrom2 property.")]
public MarketDataTypes? BuildCandlesFrom { get; set; }

Property Value

MarketDataTypes?

BuildCandlesFrom2

Which market-data type is used as a source value.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Source", Description = "CandlesBuildSource", GroupName = "Build", Order = 21)]
public DataType BuildCandlesFrom2 { get; set; }

Property Value

DataType

BuildCandlesMode

Build mode.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Mode", Description = "BuildMode", GroupName = "Build", Order = 20)]
public MarketDataBuildModes BuildCandlesMode { get; set; }

Property Value

MarketDataBuildModes

CandleType

The candle type.

[Browsable(false)]
public Type CandleType { get; set; }

Property Value

Type

Count

Market-data count.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Count", Description = "CandlesCount", GroupName = "General", Order = 7)]
public long? Count { get; set; }

Property Value

long?

FillGaps

Try fill gaps.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Gaps", Description = "FillGaps", GroupName = "Build", Order = 24)]
[Obsolete("Use separate subscriptions.")]
public bool FillGaps { get; set; }

Property Value

bool

From

The initial date from which you need to get data.

[Display(ResourceType = typeof(LocalizedStrings), Name = "From", Description = "StartDateDesc", GroupName = "General", Order = 3)]
public DateTimeOffset? From { get; set; }

Property Value

DateTimeOffset?

IsCalcVolumeProfile

To perform the calculation PriceLevels. By default, it is disabled.

[Display(ResourceType = typeof(LocalizedStrings), Name = "VolumeProfile", Description = "VolumeProfileCalc", GroupName = "General", Order = 2)]
public bool IsCalcVolumeProfile { get; set; }

Property Value

bool

IsFinishedOnly

Request Finished only candles.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Finished", Description = "Finished", GroupName = "Build", Order = 23)]
public bool IsFinishedOnly { get; set; }

Property Value

bool

IsRegularTradingHours

Use only the regular trading hours for which data will be requested.

[Display(ResourceType = typeof(LocalizedStrings), Name = "RegularHours", Description = "RegularTradingHours", GroupName = "General", Order = 6)]
public bool? IsRegularTradingHours { get; set; }

Property Value

bool?

Security

The instrument to be used for candles formation.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Security", Description = "SecurityDot", GroupName = "General", Order = 0)]
public Security Security { get; set; }

Property Value

Security

To

The final date by which you need to get data.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Until", Description = "ToDateDesc", GroupName = "General", Order = 4)]
public DateTimeOffset? To { get; set; }

Property Value

DateTimeOffset?

WorkingTime

The time boundary, within which candles for give series shall be translated.

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

Property Value

WorkingTime

Methods

Load(SettingsStorage)

Load settings.

public void Load(SettingsStorage storage)

Parameters

storage SettingsStorage

Settings storage.

Save(SettingsStorage)

Save settings.

public void Save(SettingsStorage storage)

Parameters

storage SettingsStorage

Settings storage.

ToString() 

public override string ToString()

Returns

string