Class CandleChart

Candlestick chart control derived from UserControl.

Inheritance

System.Object

System.Windows.Threading.DispatcherObject

System.Windows.DependencyObject

System.Windows.Media.Visual

System.Windows.UIElement

System.Windows.FrameworkElement

System.Windows.Controls.Control

System.Windows.Controls.ContentControl

System.Windows.Controls.UserControl

CandleChart

Implements

System.Windows.Media.Animation.IAnimatable

System.Windows.IFrameworkInputElement

System.Windows.IInputElement

System.ComponentModel.ISupportInitialize

System.Windows.Markup.IQueryAmbient

System.Windows.Markup.IAddChild

System.ComponentModel.INotifyPropertyChanged

Namespace: FancyCandles

Assembly: FancyCandles.dll

Syntax

[JsonObject(MemberSerialization.OptIn)]
public class CandleChart : UserControl, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, INotifyPropertyChanged

Constructors

CandleChart()

Default constructor.

Declaration

public CandleChart()

Fields

AddInIndicatorsFolderProperty

Identifies the AddInIndicatorsFolder dependency property.

Declaration

public static readonly DependencyProperty AddInIndicatorsFolderProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

AxisTickColorProperty

Identifies the AxisTickColor dependency property.

Declaration

public static readonly DependencyProperty AxisTickColorProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

AxisTickLabelFontFamilyProperty

Identifies the AxisTickLabelFontFamily dependency property.

Declaration

public static readonly DependencyProperty AxisTickLabelFontFamilyProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

BearishCandleFillProperty

Identifies the BearishCandleFill dependency property.

Declaration

public static readonly DependencyProperty BearishCandleFillProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

BearishCandleStrokeProperty

Identifies the BearishCandleStroke dependency property.

Declaration

public static readonly DependencyProperty BearishCandleStrokeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

BearishVolumeBarFillProperty

Identifies the BearishVolumeBarFill dependency property.

Declaration

public static readonly DependencyProperty BearishVolumeBarFillProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

BullishCandleFillProperty

Identifies the BullishCandleFill dependency property.

Declaration

public static readonly DependencyProperty BullishCandleFillProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

BullishCandleStrokeProperty

Identifies the BullishCandleStroke dependency property.

Declaration

public static readonly DependencyProperty BullishCandleStrokeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

BullishVolumeBarFillProperty

Identifies the BullishVolumeBarFill dependency property.

Declaration

public static readonly DependencyProperty BullishVolumeBarFillProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CandlesSourceProperty

Identifies the CandlesSource dependency property.

Declaration

public static readonly DependencyProperty CandlesSourceProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CandlesSourceProviderProperty

Identifies the CandlesSourceProvider dependency property.

Declaration

public static readonly DependencyProperty CandlesSourceProviderProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

ChartAreaBackgroundProperty

Identifies the ChartAreaBackground dependency property.

Declaration

public static readonly DependencyProperty ChartAreaBackgroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

ChartAreaBorderColorProperty

Identifies the ChartAreaBorderColor dependency property.

Declaration

public static readonly DependencyProperty ChartAreaBorderColorProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CrossLinesBrushProperty

Identifies the CrossLinesBrush dependency property.

Declaration

public static readonly DependencyProperty CrossLinesBrushProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CrossPriceLabelBackgroundProperty

Identifies the CrossPriceLabelBackground dependency property.

Declaration

public static readonly DependencyProperty CrossPriceLabelBackgroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CrossPriceLabelForegroundProperty

Identifies the CrossPriceLabelForeground dependency property.

Declaration

public static readonly DependencyProperty CrossPriceLabelForegroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CultureProperty

Identifies the Culture dependency property.

Declaration

public static readonly DependencyProperty CultureProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CurrentPriceLabelBackgroundProperty

Identifies the CurrentPriceLabelBackground dependency property.

Declaration

public static readonly DependencyProperty CurrentPriceLabelBackgroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

CurrentPriceLabelForegroundProperty

Identifies the CurrentPriceLabelForeground dependency property.

Declaration

public static readonly DependencyProperty CurrentPriceLabelForegroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

DefaultInitialCandleGap

Gets the default value for the InitialCandleGap property.

Declaration

public readonly double DefaultInitialCandleGap

Field Value

Type	Description
System.Double	The default value for the InitialCandleGap property, in device-independent units: 1.0.

See Also

InitialCandleGap

CandleGap

DefaultInitialCandleWidth

Gets the default value for the InitialCandleWidth property.

Declaration

public readonly double DefaultInitialCandleWidth

Field Value

Type	Description
System.Double	The default value for the InitialCandleWidth property, in device-independent units: 3.0.

See Also

InitialCandleWidth

CandleWidth

DisabledFillProperty

Identifies the DisabledFill dependency property.

Declaration

public static readonly DependencyProperty DisabledFillProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

GapBetweenPriceTickLabelsProperty

Identifies the GapBetweenPriceTickLabels dependency property.

Declaration

public static readonly DependencyProperty GapBetweenPriceTickLabelsProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

HideMinorVerticalGridlinesProperty

Identifies the HideMinorVerticalGridlines dependency property.

Declaration

public static readonly DependencyProperty HideMinorVerticalGridlinesProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

HorizontalGridlinesPenProperty

Identifies the HorizontalGridlinesPen dependency property.

Declaration

public static readonly DependencyProperty HorizontalGridlinesPenProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

IsCrossLinesVisibleProperty

Identifies the IsCrossLinesVisible dependency property.

Declaration

public static readonly DependencyProperty IsCrossLinesVisibleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

IsCrossPriceLabelVisibleProperty

Identifies the IsCrossPriceLabelVisible dependency property.

Declaration

public static readonly DependencyProperty IsCrossPriceLabelVisibleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

IsCurrentPriceLabelVisibleProperty

Identifies the IsCurrentPriceLabelVisible dependency property.

Declaration

public static readonly DependencyProperty IsCurrentPriceLabelVisibleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

IsHorizontalGridlinesEnabledProperty

Identifies the IsHorizontalGridlinesEnabled dependency property.

Declaration

public static readonly DependencyProperty IsHorizontalGridlinesEnabledProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

IsVerticalGridlinesEnabledProperty

Identifies the IsVerticalGridlinesEnabled dependency property.

Declaration

public static readonly DependencyProperty IsVerticalGridlinesEnabledProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

IsVolumePanelVisibleProperty

Identifies the IsVolumePanelVisible dependency property.

Declaration

public static readonly DependencyProperty IsVolumePanelVisibleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendFontFamilyProperty

Identifies the LegendFontFamily dependency property.

Declaration

public static readonly DependencyProperty LegendFontFamilyProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendFontSizeProperty

Identifies the LegendFontSize dependency property.

Declaration

public static readonly DependencyProperty LegendFontSizeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendFontStyleProperty

Identifies the LegendFontStyle dependency property.

Declaration

public static readonly DependencyProperty LegendFontStyleProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendFontWeightProperty

Identifies the LegendFontWeight dependency property.

Declaration

public static readonly DependencyProperty LegendFontWeightProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendForegroundProperty

Identifies the LegendForeground dependency property.

Declaration

public static readonly DependencyProperty LegendForegroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendHorizontalAlignmentProperty

Identifies the LegendHorizontalAlignment dependency property.

Declaration

public static readonly DependencyProperty LegendHorizontalAlignmentProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendMarginProperty

Identifies the LegendMargin dependency property.

Declaration

public static readonly DependencyProperty LegendMarginProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendTextProperty

Identifies the LegendText dependency property.

Declaration

public static readonly DependencyProperty LegendTextProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

LegendVerticalAlignmentProperty

Identifies the LegendVerticalAlignment dependency property.

Declaration

public static readonly DependencyProperty LegendVerticalAlignmentProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

MouseWheelModifierKeyForCandleWidthChangingProperty

Identifies the MouseWheelModifierKeyForCandleWidthChanging dependency property.

Declaration

public static readonly DependencyProperty MouseWheelModifierKeyForCandleWidthChangingProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

MouseWheelModifierKeyForScrollingThroughCandlesProperty

Identifies the MouseWheelModifierKeyForScrollingThroughCandles dependency property.

Declaration

public static readonly DependencyProperty MouseWheelModifierKeyForScrollingThroughCandlesProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

OverlayIndicatorsProperty

Identifies the OverlayIndicators dependency property.

Declaration

public static readonly DependencyProperty OverlayIndicatorsProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

PriceAxisTickLabelFontSizeProperty

Identifies the PriceAxisTickLabelFontSize dependency property.

Declaration

public static readonly DependencyProperty PriceAxisTickLabelFontSizeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

PriceChartBottomMarginProperty

Identifies the PriceChartBottomMargin dependency property.

Declaration

public static readonly DependencyProperty PriceChartBottomMarginProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

PriceChartTopMarginProperty

Identifies the PriceChartTopMargin dependency property.

Declaration

public static readonly DependencyProperty PriceChartTopMarginProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

ScrollBarBackgroundProperty

Identifies the ScrollBarBackground dependency property.

Declaration

public static readonly DependencyProperty ScrollBarBackgroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

ScrollBarHeightProperty

Identifies the ScrollBarHeight dependency property.

Declaration

public static readonly DependencyProperty ScrollBarHeightProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

TimeAxisTickLabelFontSizeProperty

Identifies the TimeAxisTickLabelFontSize dependency property.

Declaration

public static readonly DependencyProperty TimeAxisTickLabelFontSizeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

ToolTipFontSize

Declaration

public static readonly double ToolTipFontSize

Field Value

Type	Description
System.Double

VerticalGridlinesPenProperty

Identifies the VerticalGridlinesPen dependency property.

Declaration

public static readonly DependencyProperty VerticalGridlinesPenProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

VisibleCandlesRangeProperty

Identifies the VisibleCandlesRange dependency property.

Declaration

public static readonly DependencyProperty VisibleCandlesRangeProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

VolumeBarWidthToCandleWidthRatioProperty

Identifies the VolumeBarWidthToCandleWidthRatio dependency property.

Declaration

public static readonly DependencyProperty VolumeBarWidthToCandleWidthRatioProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

VolumeHistogramBottomMarginProperty

Identifies the VolumeHistogramBottomMargin dependency property.

Declaration

public static readonly DependencyProperty VolumeHistogramBottomMarginProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

VolumeHistogramTopMarginProperty

Identifies the VolumeHistogramTopMargin dependency property.

Declaration

public static readonly DependencyProperty VolumeHistogramTopMarginProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

WaitIndicatorForegroundProperty

Identifies the WaitIndicatorForeground dependency property.

Declaration

public static readonly DependencyProperty WaitIndicatorForegroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty	System.Windows.DependencyProperty

Properties

AddInIndicatorsFolder

Gets or sets the folder with an assemblies containing user's add-in technical indicators.

Declaration

public string AddInIndicatorsFolder { get; set; }

Property Value

Type	Description
System.String	The path to the folder containing user's add-in technical indicators. The default value is empty string.

Remarks

Adding your own technical indicator classes, derived from OverlayIndicator, to Startup project of your solution is not the only way to add new indicators to your application.

You or even users of your application can add a new add-in indicator by creating it in a separate solution. You have to do the following:

• Add a new indicator class derived from OverlayIndicator in a new project inside a new solution and build an assembly.
• Locate the assembly file containing the new indicator class in some folder, usually below your main application root directory.
• Specify the aforementioned folder path in the AddInIndicatorsFolder of your application.

The path can be full or relative to the BaseDirectory of your application.

For example, it could look like this:

<fc:CandleChart AddInIndicatorsAssemblyPath="AddInIndicators"/>

In the example above, folder "AddInIndicators" must be located inside the base folder of your application. There can be multiple assembly files in this folder. All of them will be found by the CandleChart element.

Identifier field	AddInIndicatorsFolderProperty
Metadata properties set to True	-

See Also

Creating your own overlay technical indicator

OverlayIndicators

AddOverlayIndicatorCommand

Gets the Command for adding new indicator object to the OverlayIndicators collection.

Declaration

public RelayCommand AddOverlayIndicatorCommand { get; }

Property Value

Type	Description
FancyPrimitives.RelayCommand	The Command for adding new indicator object to the OverlayIndicators collection.

Remarks

AddOverlayIndicatorCommand creates a new indicator object of specified in the Command parameter type and adds it to the OverlayIndicator collection. The Command parameter must contain the Type of overlay indicator to be added. It must be the type of class derived from OverlayIndicator. The new indicator is created with default parameters. You have to tune up its parameters after adding it to OverlayIndicators.

AxisTickColor

Gets or sets the color of ticks and its labels for all the axises.

Declaration

[JsonProperty]
public Brush AxisTickColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The color of ticks and its labels for all the axises. The default is determined by the DefaultAxisTickColor value.

Remarks

Dependency Property Information

Identifier field	AxisTickColorProperty
Metadata properties set to True	-

AxisTickLabelFontFamily

Gets or sets the tick label font family for all the axises.

Declaration

[JsonProperty]
public FontFamily AxisTickLabelFontFamily { get; set; }

Property Value

Type	Description
System.Windows.Media.FontFamily	The tick label font family for all the axises. The default is SystemFonts.MessageFontFamily.

Remarks

Dependency Property Information

Identifier field	AxisTickLabelFontFamilyProperty
Metadata properties set to True	-

BearishCandleFill

Gets or sets the Brush that specifies how the body of the bearish candle is painted.

Declaration

[JsonProperty]
public Brush BearishCandleFill { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The brush to paint the bodies of the bearish candles. The default value is determined by the DefaultBearishCandleFill property.

Remarks

Usually candles are separated into two types - Bullish and Bearish. The Bullish candle has its Close price higher than its Open price. All other candles are Bearish. To visualize such a separation usually the Bearish and Bullish candles are painted in different Fill and Stroke (outline) colors. To set the Brush for the candle outline (the tails and the body outline) use the BullishCandleStroke and BearishCandleStroke properties for the bullish and bearish candles respectively.

Dependency Property Information

Identifier field	BearishCandleFillProperty
Metadata properties set to True	-

See Also

BullishCandleFill

BullishCandleStroke

BearishCandleStroke

BearishCandleStroke

Gets or sets the Brush that specifies how the outline of the bearish candle is painted.

Declaration

[JsonProperty]
public Brush BearishCandleStroke { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The Brush to paint the tails and the body outline of the bearish candles. The default value is determined by the DefaultBearishCandleStroke property.

Remarks

Usually candles are separated into two types - Bullish and Bearish. The Bullish candle has its Close price higher than its Open price. All other candles are Bearish. To visualize such a separation usually the Bearish and Bullish candles are painted in different Fill and Stroke (outline) colors. To set the Brush for the candle body fill use the BullishCandleFill and BearishCandleFill properties for the bullish and bearish candles respectively.

Dependency Property Information

Identifier field	BearishCandleStrokeProperty
Metadata properties set to True	-

See Also

BullishCandleStroke

BullishCandleFill

BearishCandleFill

BearishVolumeBarFill

Gets or sets the color of the bearish volume bar.

Declaration

[JsonProperty]
public Brush BearishVolumeBarFill { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The brush to fill all bearish volume bars. The default is determined by the DefaultBearishVolumeBarFill value.

Remarks

We separate all volume bars to "bullish" or "bearish" according to whether the correspondent candle is bullish or bearish. The Bullish candle has its Close higher than its Open. The Bearish candle has its Close lower than its Open. To visualize such a separation all bars are painted into two different colors - BullishVolumeBarFill and BearishVolumeBarFill for bullish and bearish bars respectively. Likewise you can set the BullishCandleFill and BearishCandleFill properties to change the appearance of bullish and bearish price candles.

Dependency Property Information

Identifier field	BearishVolumeBarFillProperty
Metadata properties set to True	-

BullishCandleFill

Gets or sets the Brush that specifies how the body of the bullish candle is painted.

Declaration

[JsonProperty]
public Brush BullishCandleFill { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The brush to paint the bodies of the bullish candles. The default value is determined by the DefaultBullishCandleFill property.

Remarks

Usually candles are separated into two types - Bullish and Bearish. The Bullish candle has its Close price higher than its Open price. All other candles are Bearish. To visualize such a separation usually the Bearish and Bullish candles are painted in different Fill and Stroke (outline) colors. To set the Brush for the candle outline (the tails and the body outline) use the BullishCandleStroke and BearishCandleStroke properties for the bullish and bearish candles respectively.

Dependency Property Information

Identifier field	BullishCandleFillProperty
Metadata properties set to True	-

See Also

BearishCandleFill

BearishCandleStroke

BullishCandleStroke

BullishCandleStroke

Gets or sets the Brush that specifies how the outline of the bullish candle is painted.

Declaration

[JsonProperty]
public Brush BullishCandleStroke { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The Brush to paint the tails and the body outline of the bullish candles. The default value is determined by the DefaultBullishCandleStroke property.

Remarks

Usually candles are separated into two types - Bullish and Bearish. The Bullish candle has its Close price higher than its Open price. All other candles are Bearish. To visualize such a separation usually the Bearish and Bullish candles are painted in different Fill and Stroke (outline) colors. To set the Brush for the candle body fill use the BullishCandleFill and BearishCandleFill properties for the bullish and bearish candles respectively.

Dependency Property Information

Identifier field	BullishCandleStrokeProperty
Metadata properties set to True	-

See Also

BearishCandleStroke

BearishCandleFill

BullishCandleFill

BullishVolumeBarFill

Gets or sets the color of the bullish volume bar.

Declaration

[JsonProperty]
public Brush BullishVolumeBarFill { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The brush to fill all bullish volume bars. The default is determined by the DefaultBullishVolumeBarFill value.

Remarks

We separate all volume bars to "bullish" or "bearish" according to whether the correspondent candle is bullish or bearish. A candle is bullish if its Close higher than its Open. A candle is Bearish if its Close lower than its Open. To visualize such a separation all bars are painted into two different colors - BullishVolumeBarFill and BearishVolumeBarFill for bullish and bearish bars respectively. Likewise you can set the BullishCandleFill and BearishCandleFill properties to change the appearance of bullish and bearish price candles.

Dependency Property Information

Identifier field	BullishVolumeBarFillProperty
Metadata properties set to True	-

CandleGap

Gets the horizontal gap between adjacent candles.

Declaration

public double CandleGap { get; }

Property Value

Type	Description
System.Double	The horizontal gap between adjacent candles, in device-independent units (1/96th inch per unit).

Remarks

Initially after loading this property value is equal to the InitialCandleGap, but then it changes due to user's manipulations.

See Also

DefaultInitialCandleGap

InitialCandleGap

CandleWidth

CandlesSource

Declaration

public ICandlesSource CandlesSource { get; set; }

Property Value

Type	Description
ICandlesSource

CandlesSourceProvider

Gets or sets the provider of candle collections, that can be used as a value for the CandlesSource property.

Declaration

public ICandlesSourceProvider CandlesSourceProvider { get; set; }

Property Value

Type	Description
ICandlesSourceProvider	The provider of candle collections, which can be used as a value for the CandlesSource property.

Remarks

Using the CandlesSourceProvider property is optional. You can set the CandlesSource property to populate your CandleChart with candle data and it's absolutely ok. But if you want to provide the ability to select a security and time frame from the CandleChart context menu you have to set the CandlesSourceProvider property. ICandlesSourceProvider provides a list of available securities and time frames and, of course, a candle data to use with CandleChart. Setting this property makes the Select New Security and Time Frame items of the CandleChart context menu enabled. When a user of your application has selected a new security or time frame, a new value will be assigned to the CandlesSource property.

Take a note, that the CandlesSource property support IResourceWithUserCounter types. Every time you sets the CandlesSource property value, it calls the IncreaseUserCount() method of the new value and the the DecreaseUserCount() method of the old value if they implement the IResourceWithUserCounter interface. It can be helpful in some scenarios where you want to optimize the number of candle sources in your application and delete those that are not in use.

CandleWidth

Gets the width of the candle.

Declaration

public double CandleWidth { get; }

Property Value

Type	Description
System.Double	The candle width, in device-independent units (1/96th inch per unit).

Remarks

Initially after loading this property value is equal to the InitialCandleWidth, but then it changes due to user's manipulations.

See Also

InitialCandleWidth

DefaultInitialCandleWidth

CandleGap

ChangeCurrentTimeframeCommand

Gets the Command for changing the current time frame.

Declaration

public RelayCommand ChangeCurrentTimeframeCommand { get; }

Property Value

Type	Description
FancyPrimitives.RelayCommand	The command for changing the current time frame.

Remarks

This command can be executed only if the current CandlesSource value is of type ICandlesSourceFromProvider and SecCatalog of CandlesSourceProvider contains the current financial instrument. It gets the new ICandlesSource value from CandlesSourceProvider of the same financial instrument but of the new time frame and assigns it to the CandlesSource property. The command receives the new TimeFrame value as a command parameter;

ChartAreaBackground

Gets or sets the background of the price chart and volume diagram areas.

Declaration

[JsonProperty]
public Brush ChartAreaBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The background of the price chart and volume diagram areas. The default is determined by the DefaultChartAreaBackground values.

Remarks

This background is not applied to the horizontal and vertical axis areas, which contain tick marks and labels.

Identifier field	ChartAreaBackgroundProperty
Metadata properties set to True	-

ChartAreaBorderColor

Gets or sets the border color of the price chart and volume diagram areas.

Declaration

[JsonProperty]
public Brush ChartAreaBorderColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The border color of the price chart and volume diagram areas. The default is determined by the DefaultChartAreaBorderColor values.

Remarks

Identifier field	ChartAreaBorderColorProperty
Metadata properties set to True	-

CrossLinesBrush

Gets or sets the brush for the cross lines.

Declaration

[JsonProperty]
public Brush CrossLinesBrush { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The brush for the cross lines. The default is determined by the DefaultCrossLinesBrushvalues.

Remarks

The Cross lines always have a thickness of 1.0.

Identifier field	CrossLinesBrushProperty
Metadata properties set to True	-

CrossPriceLabelBackground

Gets or sets the background for the price or volume label of the cross.

Declaration

[JsonProperty]
public Brush CrossPriceLabelBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The background for the price or volume label of the cross. The default is determined by the DefaultCrossPriceLabelBackgroundvalues.

Remarks

The price (or volume) value label locates on the price (or volume) axis area.

Identifier field	CrossPriceLabelBackgroundProperty
Metadata properties set to True	-

CrossPriceLabelForeground

Gets or sets the foreground for the price (or volume) label of the cross.

Declaration

[JsonProperty]
public Brush CrossPriceLabelForeground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The foreground for the price or volume label of the cross. The default is determined by the DefaultCrossPriceLabelForegroundvalues.

Remarks

The price (or volume) value label locates on the price (or volume) axis area.

Identifier field	CrossPriceLabelForegroundProperty
Metadata properties set to True	-

Culture

Gets or sets the specific culture that will be used to draw price, volume, date and time values.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type	Description
System.Globalization.CultureInfo	The specific culture that will be used to draw price, volume, date and time values. The default is CultureInfo.CurrentCulture.

CurrentMousePosition

This is a property for internal use only. You should not use it.

Declaration

public Point CurrentMousePosition { get; }

Property Value

Type	Description
System.Windows.Point

CurrentPrice

Gets the current price value - the closing price of the last candle.

Declaration

public double CurrentPrice { get; }

Property Value

Type	Description
System.Double	The current price value - the closing price of the last candle.

See Also

IsCurrentPriceLabelVisible

CurrentPriceLabelBackground

Gets or sets the background for the current price label on the price axis.

Declaration

[JsonProperty]
public Brush CurrentPriceLabelBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The background for the current price label on the price axis. The default is determined by the DefaultCurrentPriceLabelBackgroundvalues.

Remarks

The price (or volume) value label locates on the price (or volume) axis area.

Identifier field	CurrentPriceLabelBackgroundProperty
Metadata properties set to True	-

CurrentPriceLabelForeground

Gets or sets the foreground for the current price label on the price axis.

Declaration

[JsonProperty]
public Brush CurrentPriceLabelForeground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The foreground for the current price label on the price axis. The default is determined by the DefaultCurrentPriceLabelForegroundvalues.

Remarks

The price (or volume) value label locates on the price (or volume) axis area.

Identifier field	CurrentPriceLabelForegroundProperty
Metadata properties set to True	-

DefaultAxisTickColor

Gets the default value for the AxisTickColor property.

Declaration

public static Brush DefaultAxisTickColor { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the AxisTickColor property: Brushes.Black.

DefaultBearishCandleFill

Gets the default value for the BearishCandleFill property.

Declaration

public static Brush DefaultBearishCandleFill { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the BearishCandleFill property: Brushes.Red.

See Also

BearishCandleFill

DefaultBearishCandleStroke

Gets the default value for the BearishCandleStroke property.

Declaration

public static Brush DefaultBearishCandleStroke { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the BearishCandleStroke property: Brushes.Red.

See Also

BearishCandleStroke

DefaultBearishVolumeBarFill

Gets the default value for the BearishVolumeBarFill property.

Declaration

public static Brush DefaultBearishVolumeBarFill { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the BearishVolumeBarFill property: Brushes.Red.

See Also

BearishVolumeBarFill

DefaultBullishCandleFill

Gets the default value for the BullishCandleFill property.

Declaration

public static Brush DefaultBullishCandleFill { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the BullishCandleFill property: Brushes.Green.

See Also

BullishCandleFill

DefaultBullishCandleStroke

Gets the default value for the BullishCandleStroke property.

Declaration

public static Brush DefaultBullishCandleStroke { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the BullishCandleStroke property: Brushes.Green.

See Also

BullishCandleStroke

DefaultBullishVolumeBarFill

Gets the default value for the BullishVolumeBarFill property.

Declaration

public static Brush DefaultBullishVolumeBarFill { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the BullishVolumeBarFill property: Brushes.Green.

See Also

BullishVolumeBarFill

DefaultChartAreaBackground

Gets the default value for the ChartAreaBackground property.

Declaration

public static Brush DefaultChartAreaBackground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the ChartAreaBackground property: #FFFFFDE9.

DefaultChartAreaBorderColor

Gets the default value for the ChartAreaBorderColor property.

Declaration

public static Brush DefaultChartAreaBorderColor { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the ChartAreaBorderColor property: Black.

DefaultCrossLinesBrush

Gets the default value for the CrossLinesBrush property.

Declaration

public static Brush DefaultCrossLinesBrush { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the CrossLinesBrush property: #1E000A97.

DefaultCrossPriceLabelBackground

Gets the default value for the CrossPriceLabelBackground property.

Declaration

public static Brush DefaultCrossPriceLabelBackground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default System.Windows.Media.Brush value for the CrossPriceLabelBackground property: #FFE8EDFF.

DefaultCrossPriceLabelForeground

Gets the default value for the CrossPriceLabelForeground property.

Declaration

public static Brush DefaultCrossPriceLabelForeground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the CrossPriceLabelForeground property: Brushes.Red.

DefaultCurrentPriceLabelBackground

Gets the default value for the CurrentPriceLabelBackground property.

Declaration

public static Brush DefaultCurrentPriceLabelBackground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default System.Windows.Media.Brush value for the CurrentPriceLabelBackground property: #FFE8EDFF.

DefaultCurrentPriceLabelForeground

Gets the default value for the CurrentPriceLabelForeground property.

Declaration

public static Brush DefaultCurrentPriceLabelForeground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the CurrentPriceLabelForeground property: Brushes.Red.

DefaultDisabledFill

Gets the default value for the DisabledFill property.

Declaration

public static Brush DefaultDisabledFill { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the DisabledFill property: #CCAAAAAA.

DefaultGapBetweenPriceTickLabels

Gets the default value for the GapBetweenPriceTickLabels property.

Declaration

public static double DefaultGapBetweenPriceTickLabels { get; }

Property Value

Type	Description
System.Double	The default value for the GapBetweenPriceTickLabels property: 0.0.

DefaultHideMinorVerticalGridlines

Gets the default value for the HideMinorVerticalGridlines property.

Declaration

public static bool DefaultHideMinorVerticalGridlines { get; }

Property Value

Type	Description
System.Boolean	The default value for the HideMinorVerticalGridlines property: False.

DefaultHorizontalGridlinesBrush

Gets the default value for the Brush constituent of the HorizontalGridlinesPen property.

Declaration

public static Brush DefaultHorizontalGridlinesBrush { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the System.Windows.Media.Brush constituent of the HorizontalGridlinesPen property: #1E000000.

See Also

DefaultHorizontalGridlinesThickness

DefaultHorizontalGridlinesThickness

Gets the default value for Thickness constituent of the HorizontalGridlinesPen property.

Declaration

public static double DefaultHorizontalGridlinesThickness { get; }

Property Value

Type	Description
System.Double	The default value for the Thickness constituent of the HorizontalGridlinesPen property: 1.0.

See Also

DefaultHorizontalGridlinesBrush

DefaultIsCrossLinesVisible

Gets the default value for the IsCrossLinesVisible property.

Declaration

public static bool DefaultIsCrossLinesVisible { get; }

Property Value

Type	Description
System.Boolean	The default value for the IsCrossLinesVisible property: true.

DefaultIsCrossPriceLabelVisible

Gets the default value for the IsCrossLinesVisible property.

Declaration

public static bool DefaultIsCrossPriceLabelVisible { get; }

Property Value

Type	Description
System.Boolean	The default value for the IsCrossLinesVisible property: true.

DefaultIsHorizontalGridlinesEnabled

Gets the default value for the IsHorizontalGridlinesEnabled property.

Declaration

public static bool DefaultIsHorizontalGridlinesEnabled { get; }

Property Value

Type	Description
System.Boolean	The default value for the IsHorizontalGridlinesEnabled property: True.

DefaultIsVerticalGridlinesEnabled

Gets the default value for the IsVerticalGridlinesEnabled property.

Declaration

public static bool DefaultIsVerticalGridlinesEnabled { get; }

Property Value

Type	Description
System.Boolean	The default value for the IsVerticalGridlinesEnabled property: True.

DefaultIsVolumePanelVisible

Gets the default value for the IsVolumePanelVisible property.

Declaration

public static bool DefaultIsVolumePanelVisible { get; }

Property Value

Type	Description
System.Boolean	The default value for the IsVolumePanelVisible property: True.

DefaultLegendFontSize

Gets the default value for the LegendFontSize property.

Declaration

public static double DefaultLegendFontSize { get; }

Property Value

Type	Description
System.Double	The default value for the LegendFontSize property: 30.0.

See Also

LegendFontSize

DefaultLegendFontStyle

Gets the default value for the LegendFontStyle property.

Declaration

public static FontStyle DefaultLegendFontStyle { get; }

Property Value

Type	Description
System.Windows.FontStyle	The default value for the LegendFontStyle property: FontStyles.Normal.

See Also

LegendFontStyle

DefaultLegendFontWeight

Gets the default value for the LegendFontWeight property.

Declaration

public static FontWeight DefaultLegendFontWeight { get; }

Property Value

Type	Description
System.Windows.FontWeight	The default value for the LegendFontWeight property: FontWeights.Bold.

See Also

LegendFontWeight

DefaultLegendForeground

Gets the default value for the LegendForeground property.

Declaration

public static Brush DefaultLegendForeground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the LegendForeground property: #3C000000.

See Also

LegendForeground

DefaultLegendHorizontalAlignment

Gets the default value for the LegendHorizontalAlignment property.

Declaration

public static HorizontalAlignment DefaultLegendHorizontalAlignment { get; }

Property Value

Type	Description
System.Windows.HorizontalAlignment	The default value for the LegendHorizontalAlignment property: HorizontalAlignment.Left.

See Also

LegendHorizontalAlignment

DefaultLegendMargin

Gets the default value for the LegendMargin property.

Declaration

public static Thickness DefaultLegendMargin { get; }

Property Value

Type	Description
System.Windows.Thickness	The default value for the LegendMargin property: (10, 0, 10, 0).

See Also

LegendMargin

DefaultLegendText

Gets the default value for the LegendText property.

Declaration

public static string DefaultLegendText { get; }

Property Value

Type	Description
System.String	The default value for the LegendText property: "DefaultLegend".

See Also

LegendText

DefaultLegendVerticalAlignment

Gets the default value for the LegendVerticalAlignment property.

Declaration

public static VerticalAlignment DefaultLegendVerticalAlignment { get; }

Property Value

Type	Description
System.Windows.VerticalAlignment	The default value for the LegendVerticalAlignment property: VerticalAlignment.Bottom.

See Also

LegendVerticalAlignment

DefaultPriceAxisTickLabelFontSize

Gets the default value for the PriceAxisTickLabelFontSize property.

Declaration

public static double DefaultPriceAxisTickLabelFontSize { get; }

Property Value

Type	Description
System.Double	The default value for the PriceAxisTickLabelFontSize property: 11.0.

DefaultPriceChartBottomMargin

Gets the default value for the PriceChartBottomMargin property.

Declaration

public static double DefaultPriceChartBottomMargin { get; }

Property Value

Type	Description
System.Double	The default value for the PriceChartBottomMargin property: 15.0.

See Also

PriceChartBottomMargin

DefaultPriceChartTopMargin

Gets the default value for the PriceChartTopMargin property.

Declaration

public static double DefaultPriceChartTopMargin { get; }

Property Value

Type	Description
System.Double	The default value for the PriceChartTopMargin property: 15.0.

See Also

PriceChartTopMargin

DefaultScrollBarBackground

Gets the default value for the ScrollBarBackground property.

Declaration

public static Brush DefaultScrollBarBackground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the ScrollBarBackground property: #FFF0F0F0.

DefaultScrollBarHeight

Gets the default value for the ScrollBarHeight property.

Declaration

public static double DefaultScrollBarHeight { get; }

Property Value

Type	Description
System.Double	The default value for the ScrollBarHeight property: 15.0.

DefaultTimeAxisTickLabelFontSize

Gets the default value for the TimeAxisTickLabelFontSize property.

Declaration

public static double DefaultTimeAxisTickLabelFontSize { get; }

Property Value

Type	Description
System.Double	The default value for the TimeAxisTickLabelFontSize property: 10.0.

DefaultVerticalGridlinesBrush

Gets the default value for the Brush constituent of the VerticalGridlinesPen property.

Declaration

public static Brush DefaultVerticalGridlinesBrush { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the System.Windows.Media.Brush constituent of the VerticalGridlinesPen property: #1E000000.

See Also

DefaultVerticalGridlinesThickness

DefaultVerticalGridlinesThickness

Gets the default value for Thickness constituent of the VerticalGridlinesPen property.

Declaration

public static double DefaultVerticalGridlinesThickness { get; }

Property Value

Type	Description
System.Double	The default value for the Thickness constituent of the VerticalGridlinesPen property: 1.0.

See Also

DefaultVerticalGridlinesBrush

DefaultVolumeBarWidthToCandleWidthRatio

Gets the default value for the VolumeBarWidthToCandleWidthRatio property.

Declaration

public static double DefaultVolumeBarWidthToCandleWidthRatio { get; }

Property Value

Type	Description
System.Double	The default value for the VolumeBarWidthToCandleWidthRatio property: 0.3.

See Also

VolumeBarWidthToCandleWidthRatio

DefaultVolumeHistogramBottomMargin

Gets the default value for VolumeHistogramBottomMargin property.

Declaration

public static double DefaultVolumeHistogramBottomMargin { get; }

Property Value

Type	Description
System.Double	The default value for the VolumeHistogramBottomMargin property, in device-independent units: 5.0.

DefaultVolumeHistogramTopMargin

Gets the default value for VolumeHistogramTopMargin property.

Declaration

public static double DefaultVolumeHistogramTopMargin { get; }

Property Value

Type	Description
System.Double	The default value for the VolumeHistogramTopMargin property, in device-independent units: 10.0.

DefaultWaitIndicatorForeground

Gets the default value for the WaitIndicatorForeground property.

Declaration

public static Brush DefaultWaitIndicatorForeground { get; }

Property Value

Type	Description
System.Windows.Media.Brush	The default value for the WaitIndicatorForeground property: Brushes.DarkGray.

DisabledFill

Gets or sets the fill brush for the rectangle, that covers this chart control if it has been disabled.

Declaration

[JsonProperty]
public Brush DisabledFill { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The fill brush for the rectangle, that covers this chart control if it has been disabled. The default is determined by the DefaultDisabledFillvalues.

Remarks

Identifier field	DisabledFillProperty
Metadata properties set to True	-

GapBetweenPriceTickLabels

Gets or sets the minimal gap between the adjacent price or volume tick labels.

Declaration

public double GapBetweenPriceTickLabels { get; set; }

Property Value

Type	Description
System.Double	The minimal gap between adjacent labels for the price and volume axis. It must be non-negative value. The default is determined by the DefaultGapBetweenPriceTickLabels value.

Remarks

This property regulates the density of the tick labels inside the price or volume axis area. The higher the GapBetweenPriceTickLabels, the less close adjacent labels are located.

The volume axis doesn't have its own appearance properties. Therefore, the volume axis appearance depends on price axis properties.

Dependency Property Information

Identifier field	GapBetweenPriceTickLabelsProperty
Metadata properties set to True	-

HideMinorVerticalGridlines

Gets or sets the visibility of the minor vertical gridlines.

Declaration

[JsonProperty]
public bool HideMinorVerticalGridlines { get; set; }

Property Value

Type	Description
System.Boolean	The visibility of the vertical gridlines for minor (not "round") time ticks: Visible if False; Hidden if True. The default is determined by the DefaultHideMinorVerticalGridlinesvalues.

Remarks

Sometimes you need to show gridlines only for the most round time or date values, and hide other minor gridlines. In that case you need to set both the IsVerticalGridlinesEnabled and the HideMinorVerticalGridlines properties to True. Whether the particular timetick value is Minor or not depends on the current timeframe. The common rule is: round time or date values are Major, others are Minor.

Identifier field	HideMinorVerticalGridlinesProperty
Metadata properties set to True	-

See Also

IsVerticalGridlinesEnabled

HorizontalGridlinesPen

Gets or sets the pen for the horizontal gridlines.

Declaration

[JsonProperty]
public Pen HorizontalGridlinesPen { get; set; }

Property Value

Type	Description
System.Windows.Media.Pen	The pen for the horizontal gridlines. The default is determined by the DefaultHorizontalGridlinesBrush and DefaultHorizontalGridlinesThickness values.

Remarks

Dependency Property Information

Identifier field	HorizontalGridlinesPenProperty
Metadata properties set to True	-

InitialCandleGap

Gets or sets the initial gap between adjacent candles.

Declaration

public double InitialCandleGap { get; set; }

Property Value

Type	Description
System.Double	The initial gap between adjacent candles, in device-independent units (1/96th inch per unit). The default is determined by the DefaultInitialCandleGap value.

Remarks

Initially the gap between candles CandleGap is equal to this property value, but then the CandleGap property value changes due to user's manipulations.

See Also

DefaultInitialCandleGap

CandleGap

InitialCandleWidth

Gets or sets the initial candle width.

Declaration

public double InitialCandleWidth { get; set; }

Property Value

Type	Description
System.Double	The initial width of the candle, in device-independent units (1/96th inch per unit). The default is determined by the DefaultInitialCandleWidth value.

Remarks

Initially the width of a candle CandleWidth is equal to this property value, but then the CandleWidth property value changes due to user's manipulations.

See Also

DefaultInitialCandleWidth

CandleWidth

IsCrossLinesVisible

Gets or sets the visibility of the cross lines.

Declaration

[JsonProperty]
public bool IsCrossLinesVisible { get; set; }

Property Value

Type	Description
System.Boolean	The visibility of the crosslines: Visible if True; Hidden if False. The default is determined by the DefaultIsCrossLinesVisible values.

Remarks

The cross lines locates inside the price chart (or volume histogram) area and pass through the current mouse position. You can separately set up the visibility for the cross lines and for the correspondent price (or volume) label by setting the IsCrossLinesVisible and IsCrossPriceLabelVisible properties respectively.

Identifier field	IsCrossLinesVisibleProperty
Metadata properties set to True	-

IsCrossPriceLabelVisible

Gets or sets the visibility of the cross price (or volume) label.

Declaration

[JsonProperty]
public bool IsCrossPriceLabelVisible { get; set; }

Property Value

Type	Description
System.Boolean	The visibility of the cross price (or volume) label: Visible if True; Hidden if False. The default is determined by the DefaultIsCrossPriceLabelVisible values.

Remarks

The cross price (or volume) label locates inside the price (or volume) axis area. You can separately set up the visibility for the cross lines and for the correspondent price (or volume) label by setting the IsCrossLinesVisible and IsCrossPriceLabelVisible properties respectively.

Identifier field	DefaultIsCrossPriceLabelVisible
Metadata properties set to True	-

IsCurrentPriceLabelVisible

Gets or sets a value indicating whether the current price is shown on the price scale.

Declaration

[JsonProperty]
public bool IsCurrentPriceLabelVisible { get; set; }

Property Value

Type	Description
System.Boolean	A value indicating whether the current price is shown on the price scale. The default value is true.

Remarks

Identifier field	IsCurrentPriceLabelVisibleProperty
Metadata properties set to True	-

See Also

CurrentPrice

IsHorizontalGridlinesEnabled

Gets or sets the visibility of the horizontal gridlines.

Declaration

[JsonProperty]
public bool IsHorizontalGridlinesEnabled { get; set; }

Property Value

Type	Description
System.Boolean	The visibility of the horizontal gridlines: Visible if True; Hidden if False. The default is determined by the DefaultIsHorizontalGridlinesEnabled values.

Remarks

Identifier field	IsHorizontalGridlinesEnabledProperty
Metadata properties set to True	-

See Also

IsVerticalGridlinesEnabled

IsVerticalGridlinesEnabled

Gets or sets the visibility of the vertical gridlines.

Declaration

[JsonProperty]
public bool IsVerticalGridlinesEnabled { get; set; }

Property Value

Type	Description
System.Boolean	The visibility of the vertical gridlines: Visible if True; Hidden if False. The default is determined by the DefaultIsVerticalGridlinesEnabled values.

Remarks

This property applies to all vertical gridlines, which are showed for all ticks of the time axis. But sometimes you don't need to show all of this gridlines and want to visualize lines only for the most round time and date values. In that case you need to set both the IsVerticalGridlinesEnabled and the HideMinorVerticalGridlines properties to True.

Identifier field	IsVerticalGridlinesEnabledProperty
Metadata properties set to True	-

See Also

IsHorizontalGridlinesEnabled

IsVolumePanelVisible

Gets or sets the visibility for the volume histogram panel.

Declaration

[JsonProperty]
public bool IsVolumePanelVisible { get; set; }

Property Value

Type	Description
System.Boolean	The boolean value that means whether the volume histogram panel is visible or not. The default is determined by the DefaultIsVolumePanelVisible value.

Remarks

Dependency Property Information

Identifier field	IsVolumePanelVisibleProperty
Metadata properties set to True	-

LegendFontFamily

Gets or sets the font family of the legend.

Declaration

[JsonProperty]
public FontFamily LegendFontFamily { get; set; }

Property Value

Type	Description
System.Windows.Media.FontFamily	The font family of the legend. The default value is equal to the default value of the System.Windows.Controls.TextBlock.FontFamilyProperty.

Remarks

Dependency Property Information

Identifier field	LegendFontFamilyProperty
Metadata properties set to True	-

LegendFontSize

Gets or sets the font size of the legend. The legend locates inside the price chart area.

Declaration

[JsonProperty]
public double LegendFontSize { get; set; }

Property Value

Type	Description
System.Double	The font size of the legend. The default is determined by the DefaultLegendFontSize value.

Remarks

Dependency Property Information

Identifier field	LegendFontSizeProperty
Metadata properties set to True	-

See Also

DefaultLegendFontSize

LegendFontStyle

Gets or sets the font style of the legend.

Declaration

[JsonProperty]
public FontStyle LegendFontStyle { get; set; }

Property Value

Type	Description
System.Windows.FontStyle	The font style of the legend. The default is determined by the DefaultLegendFontStyle value.

Remarks

Dependency Property Information

Identifier field	LegendFontStyleProperty
Metadata properties set to True	-

See Also

DefaultLegendFontStyle

LegendFontWeight

Gets or sets the font weight of the legend. The legend locates inside the price chart area.

Declaration

[JsonProperty]
public FontWeight LegendFontWeight { get; set; }

Property Value

Type	Description
System.Windows.FontWeight	The font weight of the legend. The default is determined by the DefaultLegendFontWeight value.

Remarks

Dependency Property Information

Identifier field	LegendFontWeightProperty
Metadata properties set to True	-

See Also

DefaultLegendFontWeight

LegendForeground

Gets or sets the foreground of the legend. The legend locates inside the price chart area.

Declaration

[JsonProperty]
public Brush LegendForeground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The foreground of the legend. The default is determined by the DefaultLegendForeground value.

Remarks

Dependency Property Information

Identifier field	LegendForegroundProperty
Metadata properties set to True	-

See Also

DefaultLegendForeground

LegendHorizontalAlignment

Gets or sets the horizontal alignment for the legend inside the price chart area.

Declaration

[JsonProperty]
public HorizontalAlignment LegendHorizontalAlignment { get; set; }

Property Value

Type	Description
System.Windows.HorizontalAlignment	The horizontal alignment of the legend. The default is determined by the DefaultLegendHorizontalAlignment value.

Remarks

The legend locates inside the price chart area and could be horizontally and vertically aligned.

Dependency Property Information

Identifier field	LegendHorizontalAlignmentProperty
Metadata properties set to True	-

See Also

DefaultLegendHorizontalAlignment

LegendVerticalAlignment

LegendMargin

Gets or sets the margins for the legend. The legend locates inside the price chart area.

Declaration

[JsonProperty]
public Thickness LegendMargin { get; set; }

Property Value

Type	Description
System.Windows.Thickness	The legend margin. The default is determined by the DefaultLegendMargin value.

Remarks

The legend locates inside the price chart area and could be horizontally and vertically aligned. It could contain any text, describing this chart. Usually it contains a ticker symbol (a name of the security) and a timeframe, for example: "AAPL", "GOOGL, M5", "BTC/USD, D" etc.

Dependency Property Information

Identifier field	LegendMarginProperty
Metadata properties set to True	-

See Also

DefaultLegendMargin

LegendText

Gets or sets the text of the legend.

Declaration

[JsonProperty]
public string LegendText { get; set; }

Property Value

Type	Description
System.String	The text of the legend. The default is determined by the DefaultLegendText value.

Remarks

The legend could contain any text, describing this chart. Usually it contains a ticker symbol (a name of the security) and a timeframe, for example: "AAPL", "GOOGL, M5", "BTC/USD, D" etc.

Dependency Property Information

Identifier field	LegendTextProperty
Metadata properties set to True	-

See Also

DefaultLegendText

LegendVerticalAlignment

Gets or sets the vertical alignment for the legend inside the price chart area.

Declaration

[JsonProperty]
public VerticalAlignment LegendVerticalAlignment { get; set; }

Property Value

Type	Description
System.Windows.VerticalAlignment	The vertical alignment of the legend. The default is determined by the DefaultLegendVerticalAlignment value.

Remarks

The legend locates inside the price chart area and could be horizontally and vertically aligned.

Dependency Property Information

Identifier field	LegendVerticalAlignmentProperty
Metadata properties set to True	-

See Also

DefaultLegendVerticalAlignment

LegendHorizontalAlignment

MaxNumberOfCharsInPrice

Gets the maximal number of chars in a price for the current candle collection.

Declaration

public int MaxNumberOfCharsInPrice { get; }

Property Value

Type	Description
System.Int32	The maximal number of chars in a price for the current candle collection.

Remarks

This value is recalculated every time the candle collection is changed.

MaxNumberOfFractionalDigitsInPrice

Gets the maximum number of fractional digits in a price and volume for the current candle collection.

Declaration

public int MaxNumberOfFractionalDigitsInPrice { get; }

Property Value

Type	Description
System.Int32	The maximum number of fractional digits in a price and volume for the current candle collection.

Remarks

This value is recalculated every time the candle collection is changed.

MouseWheelModifierKeyForCandleWidthChanging

Gets or sets the modifier key that in conjunction with mouse wheel rolling will cause a change of the visible candles range width.

Declaration

public ModifierKeys MouseWheelModifierKeyForCandleWidthChanging { get; set; }

Property Value

Type	Description
System.Windows.Input.ModifierKeys	The the modifier key that in conjunction with mouse wheel rolling will cause a change of the visible candles range width. The default value is System.Windows.Input.ModifierKeys.None.

Remarks

Depending on the keyboard modifier keys the mouse wheel can serve for two functions: scrolling through the candle collection and changing the width of visible candles range. You can set up modifier keys for the aforementioned functions by setting the MouseWheelModifierKeyForScrollingThroughCandles and MouseWheelModifierKeyForCandleWidthChanging properties respectively.

Identifier field	VisibleCandlesRangeProperty
Metadata properties set to True	-

MouseWheelModifierKeyForScrollingThroughCandles

Gets or sets a modifier key that in conjunction with mouse wheel rolling will cause a scrolling through the candles.

Declaration

public ModifierKeys MouseWheelModifierKeyForScrollingThroughCandles { get; set; }

Property Value

Type	Description
System.Windows.Input.ModifierKeys	The the modifier key that in conjunction with mouse wheel rolling will cause a scrolling through the candles. The default value is System.Windows.Input.ModifierKeys.Control.

Remarks

Depending on the keyboard modifier keys the mouse wheel can serve for two functions: scrolling through the candle collection and changing the width of visible candles range. You can set up modifier keys for the aforementioned functions by setting the MouseWheelModifierKeyForScrollingThroughCandles and MouseWheelModifierKeyForCandleWidthChanging properties respectively.

Identifier field	VisibleCandlesRangeProperty
Metadata properties set to True	-

MoveOverlayIndicatorLeftCommand

Gets the Command for moving backward one step an indicator in the OverlayIndicators collection.

Declaration

public RelayCommand MoveOverlayIndicatorLeftCommand { get; }

Property Value

Type	Description
FancyPrimitives.RelayCommand	The Command for moving backward one step an indicator in the OverlayIndicators collection.

Remarks

MoveOverlayIndicatorLeftCommand command moves the specified indicator one step in direction to the beginning of the OverlayIndicators collection. The Command parameter must contain the index of the collection element to be moved.

See Also

MoveOverlayIndicatorRightCommand

MoveOverlayIndicatorRightCommand

Gets the Command for moving forward one step an indicator in the OverlayIndicators collection.

Declaration

public RelayCommand MoveOverlayIndicatorRightCommand { get; }

Property Value

Type	Description
FancyPrimitives.RelayCommand	The Command for moving forward one step an indicator in the OverlayIndicators collection.

Remarks

MoveOverlayIndicatorRightCommand command moves the specified indicator one step in direction to the end of the OverlayIndicators collection. The Command parameter must contain the index of the collection element to be moved.

See Also

MoveOverlayIndicatorLeftCommand

OpenSelectCandleSourceWindowCommand

Gets the Command that opens the dialog window for selecting a new financial instrument.

Declaration

public RelayCommand OpenSelectCandleSourceWindowCommand { get; }

Property Value

Type	Description
FancyPrimitives.RelayCommand	The Command that opens the dialog window for selecting a new financial instrument.

OverlayIndicators

Gets or sets the collection of technical overlay indicators attached to the price chart.

Declaration

[JsonProperty]
public ObservableCollection<OverlayIndicator> OverlayIndicators { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<OverlayIndicator>	The collection of technical overlay indicators attached to the price chart. The default is empty collection.

Remarks

This collection contains technical overlay indicators shown on the price chart area. Overlay indicators have the same unit of measure as the price has. Therefore such indicator charts can be drawn on the same panel as the price chart.

Identifier field	OverlayIndicatorsProperty
Metadata properties set to True	-

See Also

Creating your own overlay technical indicator

AddInIndicatorsFolder

PriceAxisTickLabelFontSize

Gets or sets the font size of the tick labels for the price and volume axises.

Declaration

[JsonProperty]
public double PriceAxisTickLabelFontSize { get; set; }

Property Value

Type	Description
System.Double	The font size of the tick labels for the price and volume axises. The default is determined by the DefaultPriceAxisTickLabelFontSize value.

Remarks

The volume axis doesn't have its own appearance properties. Therefore, the volume axis appearance depends on price axis properties.

Dependency Property Information

Identifier field	PriceAxisTickLabelFontSizeProperty
Metadata properties set to True	-

PriceAxisTickLabelHeight

Gets the height of the price or volume tick label.

Declaration

public double PriceAxisTickLabelHeight { get; }

Property Value

Type	Description
System.Double	The height of the price or volume tick label. This value is equals to the height of the text of the label.

Remarks

The volume tick label has the same height as the price tick label.

PriceAxisWidth

Gets the width of the price and volume axis area.

Declaration

public double PriceAxisWidth { get; }

Property Value

Type	Description
System.Double	The width of the price and volume axis area, which contains the ticks and its labels.

Remarks

The volume axis area has the same width as the price axis area.

PriceChartBottomMargin

Gets or sets the bottom margin for the price chart.

Declaration

[JsonProperty]
public double PriceChartBottomMargin { get; set; }

Property Value

Type	Description
System.Double	The bottom margin of the price chart, in device-independent units. The default is determined by the DefaultPriceChartBottomMargin value.

Remarks

You can set up top and bottom margins for the price chart inside its area by setting the PriceChartTopMargin and PriceChartBottomMargin properties respectively.

Dependency Property Information

Identifier field	PriceChartBottomMarginProperty
Metadata properties set to True	-

See Also

DefaultPriceChartBottomMargin

PriceChartTopMargin

PriceChartTopMargin

Gets or sets the top margin for the price chart.

Declaration

[JsonProperty]
public double PriceChartTopMargin { get; set; }

Property Value

Type	Description
System.Double	The top margin of the price chart, in device-independent units. The default is determined by the DefaultPriceChartTopMargin value.

Remarks

You can set up top and bottom margins for the price chart inside its area by setting the PriceChartTopMargin and PriceChartBottomMargin properties respectively.

Dependency Property Information

Identifier field	PriceChartTopMarginProperty
Metadata properties set to True	-

See Also

DefaultPriceChartTopMargin

PriceChartBottomMargin

RemoveOverlayIndicatorCommand

Gets the Command for removing an indicator object from the OverlayIndicators collection.

Declaration

public RelayCommand RemoveOverlayIndicatorCommand { get; }

Property Value

Type	Description
FancyPrimitives.RelayCommand	The RelayCommand object representing the command for removing an indicator object from the OverlayIndicators collection..

Remarks

The Command parameter must contain the index of the collection element to be removed from the OverlayIndicators collection.

ScrollBarBackground

Gets or sets the background for the scrollbar.

Declaration

[JsonProperty]
public Brush ScrollBarBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The brush for the scrollbar background. The default is determined by the DefaultScrollBarBackgroundvalues.

Remarks

Identifier field	ScrollBarBackgroundProperty
Metadata properties set to True	-

ScrollBarHeight

Gets or sets the height of the scrollbar.

Declaration

[JsonProperty]
public double ScrollBarHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the scrollbar background. The default is determined by the DefaultScrollBarHeightvalues.

Remarks

Identifier field	ScrollBarHeightProperty
Metadata properties set to True	-

TimeAxisHeight

Gets the height of the time axis area.

Declaration

public double TimeAxisHeight { get; }

Property Value

Type	Description
System.Double	The height of the time axis area, which contains the time and date ticks with its labels.

TimeAxisTickLabelFontSize

Gets or sets the font size of the tick labels for the time axis.

Declaration

[JsonProperty]
public double TimeAxisTickLabelFontSize { get; set; }

Property Value

Type	Description
System.Double	The font size of the tick labels for the time (and date) axis. The default is determined by the DefaultTimeAxisTickLabelFontSize value.

Remarks

Dependency Property Information

Identifier field	TimeAxisTickLabelFontSizeProperty
Metadata properties set to True	-

VerticalGridlinesPen

Gets or sets the pen for the vertical gridlines.

Declaration

[JsonProperty]
public Pen VerticalGridlinesPen { get; set; }

Property Value

Type	Description
System.Windows.Media.Pen	The pen for the vertical gridlines. The default is determined by the DefaultVerticalGridlinesBrush and DefaultVerticalGridlinesThickness values.

Remarks

Dependency Property Information

Identifier field	VerticalGridlinesPenProperty
Metadata properties set to True	-

VisibleCandlesExtremums

Gets the Low and High of the visible candles in vector format (Low,High).

Declaration

public CandleExtremums VisibleCandlesExtremums { get; }

Property Value

Type	Description
CandleExtremums	The Low and High of the visible candles in vector format (Low,High).

Remarks

The visible candles are those that fall inside the visible candles range, which is determined by the VisibleCandlesRange property.

The Low of a set of candles is a minimum Low value of this candles. The High of a set of candles is a maximum High value of this candles.

VisibleCandlesRange

Gets the range of indexes of candles, currently visible in this chart window.

Declaration

public IntRange VisibleCandlesRange { get; set; }

Property Value

Type	Description
IntRange	The range of indexes of candles, currently visible in this chart window. The default value is Undefined.

Remarks

This property defines the part of collection of candles CandlesSource that currently visible in the chart window.

Identifier field	VisibleCandlesRangeProperty
Metadata properties set to True	-

VolumeBarWidthToCandleWidthRatio

Gets or sets the volume bar width to the candle width ratio that eventually defines the width of the volume bar.

Declaration

[JsonProperty]
public double VolumeBarWidthToCandleWidthRatio { get; set; }

Property Value

Type	Description
System.Double	The ratio of the volume bar width to the candle width. The default is determined by the DefaultVolumeBarWidthToCandleWidthRatio value.

Remarks

We define the width of the volume bar as a variable that is dependent on the candle width as follows:

Volume bar width = VolumeBarWidthToCandleWidthRatio * CandleWidth

The value of this property must be in the range [0, 1]. If the value of this property is zero then the volume bar width will be 1.0 in device-independent units, irrespective of the candle width.

Dependency Property Information

Identifier field	VolumeBarWidthToCandleWidthRatioProperty
Metadata properties set to True	-

VolumeHistogramBottomMargin

Gets or sets the bottom margin for the volume histogram.

Declaration

[JsonProperty]
public double VolumeHistogramBottomMargin { get; set; }

Property Value

Type	Description
System.Double	The bottom margin of the volume histogram, in device-independent units. The default is determined by the DefaultVolumeHistogramBottomMargin value.

Remarks

You can set up top and bottom margins for the volume histogram inside its area by setting the VolumeHistogramTopMargin and VolumeHistogramBottomMargin properties respectively.

Dependency Property Information

Identifier field	VolumeHistogramBottomMarginProperty
Metadata properties set to True	-

VolumeHistogramTopMargin

Gets or sets the top margin for the volume histogram.

Declaration

[JsonProperty]
public double VolumeHistogramTopMargin { get; set; }

Property Value

Type	Description
System.Double	The top margin of the volume histogram, in device-independent units. The default is determined by the DefaultVolumeHistogramTopMargin value.

Remarks

You can set up top and bottom margins for the volume histogram inside its area by setting the VolumeHistogramTopMargin and VolumeHistogramBottomMargin properties respectively.

Dependency Property Information

Identifier field	VolumeHistogramTopMarginProperty
Metadata properties set to True	-

WaitIndicatorForeground

Gets or sets the color of the wait indicator.

Declaration

[JsonProperty]
public Brush WaitIndicatorForeground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	The color of the wait indicator. The default is determined by the DefaultWaitIndicatorForeground value.

Remarks

The wait indicator is located in the center of the price chart area. It becomes visible when a candle data is loading.

Identifier field	WaitIndicatorForegroundProperty
Metadata properties set to True	-

Methods

LoadSettings(String)

Loads and sets chart settings from the specified file.

Declaration

public void LoadSettings(string pathToSettingsFile)

Parameters

Type	Name	Description
System.String	pathToSettingsFile	The Path to the file containing chart settings.

See Also

SaveSettingsAs(String)

OnPropertyChanged(String)

INotifyPropertyChanged interface realization.

Declaration

protected void OnPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
System.String	propertyName

SaveSettingsAs(String)

Saves current chart settings to the specified file.

Declaration

public void SaveSettingsAs(string pathToSettingsFile)

Parameters

Type	Name	Description
System.String	pathToSettingsFile	The Path to the file to save settings to.

See Also

LoadSettings(String)

SetVisibleCandlesRangeBounds(DateTime, DateTime)

Sets the range of visible candles, that starts and ends at specified moments in time.

Declaration

public void SetVisibleCandlesRangeBounds(DateTime lowerBound, DateTime upperBound)

Parameters

Type	Name	Description
System.DateTime	lowerBound	The datetime value at which the range of visible candles must start.
System.DateTime	upperBound	The datetime value at which the range of visible candles must end.

Remarks

This function finds in the CandlesSource collection of candles two of them that has its t property equal or closest to datetime0 and datetime1. Then it sets the VisibleCandlesRange to the IntRange value that starts at the index of the first aforementioned candle, and ends at the index of the second one.

SetVisibleCandlesRangeCenter(DateTime)

Shifts the range of visible candles to the position where the t property of the central visible candle is equal (or closest) to specified value.

Declaration

public void SetVisibleCandlesRangeCenter(DateTime visibleCandlesRangeCenter)

Parameters

Type	Name	Description
System.DateTime	visibleCandlesRangeCenter	Central visible candle should have its t property equal to this parameter (or close to it as much as possible).

Events

PropertyChanged

INotifyPropertyChanged interface realization.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.Windows.Media.Animation.IAnimatable

System.Windows.IFrameworkInputElement

System.Windows.IInputElement

System.ComponentModel.ISupportInitialize

System.Windows.Markup.IQueryAmbient

System.Windows.Markup.IAddChild

System.ComponentModel.INotifyPropertyChanged