Table of Contents

Class ChartCandleElement

Namespace
StockSharp.Xaml.Charting
Assembly
StockSharp.Xaml.Charting.dll

The chart element representing a candle.

[Display(ResourceType = typeof(LocalizedStrings), Name = "CandleSettings")]
public class ChartCandleElement : ChartElement<ChartCandleElement>, ICloneable<ChartCandleElement>, ICloneable, IEquatable<ChartCandleElement>, IComparable<ChartCandleElement>, IComparable, IChartPart<ChartCandleElement>, IChartCandleElement, IChartElement, IChartPart<IChartElement>, INotifyPropertyChanging, INotifyPropertyChanged, IPersistable
Inheritance
ChartCandleElement
Implements
Inherited Members
Extension Methods

Constructors

ChartCandleElement()

Initializes a new instance of the ChartCandleElement.

public ChartCandleElement()

Properties

AntiAliasing

Candles rendering smoothing (enabled by default).

[Display(ResourceType = typeof(LocalizedStrings), Name = "AntiAliasing", Description = "CandlesRenderAntiAliasing", GroupName = "Style", Order = 40)]
public bool AntiAliasing { get; set; }

Property Value

bool

AreaColor

Area color for DrawStyle set as Area.

[Display(ResourceType = typeof(LocalizedStrings), Name = "AreaColor", Description = "AreaColorDot", GroupName = "Style", Order = 47)]
public Color? AreaColor { get; set; }

Property Value

Color?

BuyColor 

[Display(ResourceType = typeof(LocalizedStrings), Name = "Buy", Description = "BuyColor", GroupName = "VolumeSettings", Order = 24)]
public Color? BuyColor { get; set; }

Property Value

Color?

ClusterColor

Cluster color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ClusterColor", Description = "ClusterColorDot", GroupName = "VolumeSettings", Order = 13)]
public Color? ClusterColor { get; set; }

Property Value

Color?

ClusterLineColor

Cluster profile line color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ClusterLineColor", Description = "ClusterLineColorDot", GroupName = "VolumeSettings", Order = 10)]
public Color? ClusterLineColor { get; set; }

Property Value

Color?

ClusterMaxColor

Cluster max color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ClusterMaxVolumeColor", Description = "ClusterMaxVolumeColorDot", GroupName = "VolumeSettings", Order = 14)]
public Color? ClusterMaxColor { get; set; }

Property Value

Color?

ClusterSeparatorLineColor

Cluster profile separator line color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ClusterSeparatorLineColor", Description = "ClusterSeparatorLineColorDot", GroupName = "VolumeSettings", Order = 11)]
public Color? ClusterSeparatorLineColor { get; set; }

Property Value

Color?

ClusterTextColor

Cluster text color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ClusterTextColor", Description = "ClusterTextColorDot", GroupName = "VolumeSettings", Order = 12)]
public Color? ClusterTextColor { get; set; }

Property Value

Color?

Colorer

Custom elements colorer.

[Browsable(false)]
public Func<DateTimeOffset, bool, bool, Color?> Colorer { get; set; }

Property Value

Func<DateTimeOffset, bool, bool, Color?>

DownBorderColor

Border color of decreasing candle.

[Display(ResourceType = typeof(LocalizedStrings), Name = "DecreaseBorder", Description = "DecreaseBorderDesc", GroupName = "Style", Order = 31)]
public Color DownBorderColor { get; set; }

Property Value

Color

DownColor 

[Display(ResourceType = typeof(LocalizedStrings), Name = "Down", Description = "DownTrend", GroupName = "VolumeSettings", Order = 27)]
public Color? DownColor { get; set; }

Property Value

Color?

DownFillColor

Body color of decreasing candle.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Decrease", Description = "ColorOfDecreaseCandle", GroupName = "Style", Order = 30)]
public Color DownFillColor { get; set; }

Property Value

Color

DrawSeparateVolumes

Draw Buy and Sell volumes separately.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Separate", Description = "DrawSeparateVolumes", GroupName = "VolumeSettings", Order = 23)]
public bool DrawSeparateVolumes { get; set; }

Property Value

bool

DrawStyle

Style of candles rendering.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Style", Description = "StyleCandlesRender", GroupName = "Style", Order = 25)]
public ChartCandleDrawStyles DrawStyle { get; set; }

Property Value

ChartCandleDrawStyles

FontColor

Font color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "FontColor", Description = "FontColorDot", GroupName = "VolumeSettings", Order = 5)]
public Color? FontColor { get; set; }

Property Value

Color?

FontFamily

Font family for cluster text.

[Display(ResourceType = typeof(LocalizedStrings), Name = "FontFamily", Description = "FontFamily", GroupName = "VolumeSettings", Order = 20)]
[ItemsSource(typeof(FontFamilyNamesItemsSource))]
public string FontFamily { get; set; }

Property Value

string

FontSize

Font size for cluster text.

[Display(ResourceType = typeof(LocalizedStrings), Name = "FontSize", Description = "FontSize", GroupName = "VolumeSettings", Order = 21)]
public decimal FontSize { get; set; }

Property Value

decimal

FontWeight

Font weight for cluster text.

[Display(ResourceType = typeof(LocalizedStrings), Name = "FontWeight", Description = "FontWeight", GroupName = "VolumeSettings", Order = 22)]
public FontWeight FontWeight { get; set; }

Property Value

FontWeight

HorizontalVolumeColor

Horizontal volume color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "HorizontalVolumeColor", Description = "HorizontalVolumeColorDot", GroupName = "VolumeSettings", Order = 18)]
public Color? HorizontalVolumeColor { get; set; }

Property Value

Color?

HorizontalVolumeFontColor

Horizontal volume font color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "HorizontalVolumeFontColor", Description = "HorizontalVolumeFontColorDot", GroupName = "VolumeSettings", Order = 19)]
public Color? HorizontalVolumeFontColor { get; set; }

Property Value

Color?

HorizontalVolumeWidthFraction

Horizontal volume width fraction.

[Display(ResourceType = typeof(LocalizedStrings), Name = "HorizontalVolumeWidthFraction", Description = "HorizontalVolumeWidthFractionDot", GroupName = "VolumeSettings", Order = 17)]
public double HorizontalVolumeWidthFraction { get; set; }

Property Value

double

LineColor

Line color for DrawStyle Line*.

[Display(ResourceType = typeof(LocalizedStrings), Name = "LineColor", Description = "LineColorDot", GroupName = "Style", Order = 46)]
public Color? LineColor { get; set; }

Property Value

Color?

LocalHorizontalVolumes

Local horizontal volume.

[Display(ResourceType = typeof(LocalizedStrings), Name = "LocalHorizontalVolumes", Description = "LocalHorizontalVolumesDot", GroupName = "VolumeSettings", Order = 16)]
public bool LocalHorizontalVolumes { get; set; }

Property Value

bool

MaxVolumeBackground

Max volume background.

[Display(ResourceType = typeof(LocalizedStrings), Name = "MaxVolumeBackground", Description = "MaxVolumeBackground", GroupName = "VolumeSettings", Order = 9)]
public Color? MaxVolumeBackground { get; set; }

Property Value

Color?

MaxVolumeColor

Max volume foreground.

[Display(ResourceType = typeof(LocalizedStrings), Name = "MaxVolumeColor", Description = "MaxVolumeColorDot", GroupName = "VolumeSettings", Order = 9)]
public Color? MaxVolumeColor { get; set; }

Property Value

Color?

PriceStep

Price step for group volumes. null means no grouping.

[DataMember]
[Display(ResourceType = typeof(LocalizedStrings), Name = "PriceStep", Description = "MinPriceStep", GroupName = "Common", Order = 1004)]
public decimal? PriceStep { get; set; }

Property Value

decimal?

Priority 

protected override int Priority { get; }

Property Value

int

SellColor 

[Display(ResourceType = typeof(LocalizedStrings), Name = "Sell", Description = "SellColor", GroupName = "VolumeSettings", Order = 25)]
public Color? SellColor { get; set; }

Property Value

Color?

ShowAxisMarker

Show Y-axis market.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Marker", Description = "ShowAxisMarker", GroupName = "Style", Order = 50)]
public bool ShowAxisMarker { get; set; }

Property Value

bool

ShowHorizontalVolumes

Show horizontal volume.

[Display(ResourceType = typeof(LocalizedStrings), Name = "ShowHorizontalVolumes", Description = "ShowHorizontalVolumesDot", GroupName = "VolumeSettings", Order = 15)]
public bool ShowHorizontalVolumes { get; set; }

Property Value

bool

StrokeThickness

Line width (bar or border), with which candle will be drawn on chart.

[Display(ResourceType = typeof(LocalizedStrings), Name = "LineWidth", Description = "LineWidthDesc", GroupName = "Style", Order = 40)]
public int StrokeThickness { get; set; }

Property Value

int

Timeframe2Color

Timeframe #2 color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Timeframe2GridColor", Description = "Timeframe2GridColorDot", GroupName = "VolumeSettings", Order = 6)]
public Color? Timeframe2Color { get; set; }

Property Value

Color?

Timeframe2FrameColor

Timeframe #2 frame color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Timeframe2FrameColor", Description = "Timeframe2FrameColorDot", GroupName = "VolumeSettings", Order = 7)]
public Color? Timeframe2FrameColor { get; set; }

Property Value

Color?

Timeframe2Multiplier

Timeframe #2 multiplier.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Timeframe2Multiplier", Description = "TimeframeMultiplierDescr", GroupName = "VolumeSettings", Order = 3)]
public int? Timeframe2Multiplier { get; set; }

Property Value

int?

Timeframe3Color

Timeframe #3 color.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Timeframe3GridColor", Description = "Timeframe3GridColorDot", GroupName = "VolumeSettings", Order = 8)]
public Color? Timeframe3Color { get; set; }

Property Value

Color?

Timeframe3Multiplier

Timeframe #3 multiplier.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Timeframe3Multiplier", Description = "TimeframeMultiplierDescr", GroupName = "VolumeSettings", Order = 4)]
public int? Timeframe3Multiplier { get; set; }

Property Value

int?

UpBorderColor

Border color of increasing candle.

[Display(ResourceType = typeof(LocalizedStrings), Name = "IncreaseBorder", Description = "IncreaseBorderDesc", GroupName = "Style", Order = 33)]
public Color UpBorderColor { get; set; }

Property Value

Color

UpColor 

[Display(ResourceType = typeof(LocalizedStrings), Name = "Up", Description = "UpTrend", GroupName = "VolumeSettings", Order = 26)]
public Color? UpColor { get; set; }

Property Value

Color?

UpFillColor

Body color of increasing candle.

[Display(ResourceType = typeof(LocalizedStrings), Name = "Increase", Description = "ColorOfIncreaseCandle", GroupName = "Style", Order = 32)]
public Color UpFillColor { get; set; }

Property Value

Color

Methods

GetGeneratedTitle()

Get generated title.

protected override string GetGeneratedTitle()

Returns

string

Auto generate chart element title.

Load(SettingsStorage)

Load settings.

public override void Load(SettingsStorage storage)

Parameters

storage SettingsStorage

Settings storage.

OnDraw(ChartDrawData)

Draw on root element.

protected override bool OnDraw(ChartDrawData data)

Parameters

data ChartDrawData

Chart drawing data.

Returns

bool

true if the data was successfully drawn, otherwise, returns false.

Save(SettingsStorage)

Save settings.

public override void Save(SettingsStorage storage)

Parameters

storage SettingsStorage

Settings storage.