Class OverlayIndicator

Provides a base class for Overlay technical indicators, such as Moving Average, Bollinger Bands, etc.

Inheritance

System.Object

System.Windows.Threading.DispatcherObject

System.Windows.DependencyObject

OverlayIndicator

ExponentialMovingAverage

SimpleMovingAverage

Implements

System.ComponentModel.INotifyPropertyChanged

Namespace: FancyCandles.Indicators

Assembly: FancyCandles.dll

Syntax

[JsonObject(MemberSerialization.OptIn)]
public abstract class OverlayIndicator : DependencyObject, INotifyPropertyChanged

Remarks

Overlays - Technical indicators that use the same scale as prices and plotted on a price chart area.

Properties

CandlesSource

Gets or sets the underlying candle data collection.

Declaration

public IList<ICandle> CandlesSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<ICandle>	The underlying candle data collection.

Remarks

Each overlay indicator calculation is based on an underlying price data series. Usually you need to set the CandlesSource property to the same collection that you use for the CandlesSource property of the underlying CandleChart object.

FullName

Gets the full name of this OverlayIndicator object.

Declaration

public abstract string FullName { get; }

Property Value

Type	Description
System.String	The full name of this OverlayIndicator object.

Remarks

The full name of an OverlayIndicator object usually contains some of its property values.

PropertiesEditorXAML

Gets the XAML snippet representing a property editor for this OverlayIndicator object.

Declaration

public abstract string PropertiesEditorXAML { get; }

Property Value

Type	Description
System.String	The String of XAML snippet representing a property editor for this OverlayIndicator object.

Remarks

This XAML snippet can be loaded dynamically to instantiate a new element - the OverlayIndicator property editor.

ShortName

Gets the short name of this OverlayIndicator object.

Declaration

public abstract string ShortName { get; }

Property Value

Type	Description
System.String	The short name of this OverlayIndicator object.

Remarks

The short name of an OverlayIndicator object usually contains no instance parameter values.

TypeName

Gets the type name of this OverlayIndicator object.

Declaration

[JsonProperty]
public string TypeName { get; }

Property Value

Type	Description
System.String	The type name of this OverlayIndicator object.

Remarks

This property is used by serialization system.

Methods

GetIndicatorValue(Int32)

Returns this OverlayIndicator value at a specified time period.

Declaration

public abstract double GetIndicatorValue(int candle_i)

Parameters

Type	Name	Description
System.Int32	candle_i	Specifies the time period at which the OverlayIndicator value is calculated. Usually indicator value is calculated at the candle closing time.

Returns

Type	Description
System.Double	The OverlayIndicator value at a specified time period.

OnLastCandleChanged()

Declaration

protected abstract void OnLastCandleChanged()

OnNewCandleAdded()

Declaration

protected abstract void OnNewCandleAdded()

OnPropertyChanged(String)

Declaration

protected void OnPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
System.String	propertyName

OnRender(DrawingContext, IntRange, CandleExtremums, Double, Double, Double)

Draws this OverlayIndicator chart for a specified time span.

Declaration

public abstract void OnRender(DrawingContext drawingContext, IntRange visibleCandlesRange, CandleExtremums visibleCandlesExtremums, double candleWidth, double gapBetweenCandles, double RenderHeight)

Parameters

Type	Name	Description
System.Windows.Media.DrawingContext	drawingContext	Provides methods for drawing lines and shapes on the price chart area.
IntRange	visibleCandlesRange	Specifies the time span currently shown on the price chart area. The range of the candles currently visible on the price chart.
CandleExtremums	visibleCandlesExtremums	The maximal High and minimal Low of the candles in visibleCandlesRange.
System.Double	candleWidth	The Width of candle of the price chart, in device-independent units.
System.Double	gapBetweenCandles	The Gap between candles of the price chart, in device-independent units.
System.Double	RenderHeight	The height of the price chart area, in device-independent units.

Remarks

This is an analog of the UIElement.OnRender() method. Participates in rendering operations that are directed by the layout system. The rendering instructions for this indicator are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing.

ReCalcAllIndicatorValues()

Declaration

protected abstract void ReCalcAllIndicatorValues()

Events

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged