Class IgbFinancialIndicator

Represents the base functionality for a IgbDataChart financial indicator series.

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbFinancialSeries
IgbFinancialIndicator
IgbStrategyBasedIndicator
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbFinancialIndicator : IgbFinancialSeries, JsonSerializable, IDisposable

Constructors

IgbFinancialIndicator()

Declaration
public IgbFinancialIndicator()

Properties

ActualTrendLineBrush

Gets the effective TrendLineBrush for this indicator.

Declaration
public string ActualTrendLineBrush { get; set; }
Property Value
Type Description
System.String

DisplayType

Gets or sets the display for the current FinancialIndicator object.

Declaration
public IndicatorDisplayType DisplayType { get; set; }
Property Value
Type Description
IndicatorDisplayType

IgnoreFirst

Gets or sets the number of values to hide at the beginning of the indicator.

Declaration
public int IgnoreFirst { get; set; }
Property Value
Type Description
System.Int32

TrendLineBrush

Gets or sets the brush to use to draw the trend line.

Declaration
public string TrendLineBrush { get; set; }
Property Value
Type Description
System.String

TrendLineDashArray

Declaration
public double[] TrendLineDashArray { get; set; }
Property Value
Type Description
System.Double[]

TrendLinePeriod

Gets or sets the trend line period for the current series.

Declaration
public int TrendLinePeriod { get; set; }
Property Value
Type Description
System.Int32
Remarks

The typical, and initial, value for trend line period is 7.

TrendLineThickness

Gets or sets the thickness of the current indicator object's trend line.

Declaration
public double TrendLineThickness { get; set; }
Property Value
Type Description
System.Double

TrendLineType

Gets or sets the trend type for the current indicator series.

Declaration
public TrendLineType TrendLineType { get; set; }
Property Value
Type Description
TrendLineType

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Methods

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetNextOrExactIndex(Point, Boolean)

Declaration
public override int GetNextOrExactIndex(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Int32
Overrides

GetNextOrExactIndexAsync(Point, Boolean)

Declaration
public override Task<int> GetNextOrExactIndexAsync(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides

GetPreviousOrExactIndex(Point, Boolean)

Declaration
public override int GetPreviousOrExactIndex(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Int32
Overrides

GetPreviousOrExactIndexAsync(Point, Boolean)

Declaration
public override Task<int> GetPreviousOrExactIndexAsync(Point world, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides

GetSeriesValue(Point, Boolean, Boolean)

Declaration
public override double GetSeriesValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double
Overrides

GetSeriesValueAsync(Point, Boolean, Boolean)

Declaration
public override Task<double> GetSeriesValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetSeriesValueBoundingBox(Point)

Declaration
public override Rect GetSeriesValueBoundingBox(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
Rect
Overrides

GetSeriesValueBoundingBoxAsync(Point)

If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.

Declaration
public override Task<Rect> GetSeriesValueBoundingBoxAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinate for which to get a value bounding box for
Returns
Type Description
System.Threading.Tasks.Task<Rect>
Overrides

ScrollIntoView(Object)

Declaration
public override bool ScrollIntoView(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Boolean
Overrides

ScrollIntoViewAsync(Object)

Scrolls the series to display the item for the specified data item.

Declaration
public override Task<bool> ScrollIntoViewAsync(object item)
Parameters
Type Name Description
System.Object item

The data item (item) to scroll to.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides
Remarks

The series is scrolled by the minimum amount required to place the specified data item within the central 80% of the visible axis.

Implements

System.IDisposable