Class IgbFinancialPriceSeries

Represents a IgbDataChart financial price series that renders as Candlestick or OHLC representations.

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

Default required members: Open, Low, High, Close

Constructors

IgbFinancialPriceSeries()

Declaration
public IgbFinancialPriceSeries()

Properties

ActualTrendLineBrush

Gets the effective TrendLineBrush for this FinancialPriceSeries.

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

CategoryCollisionMode

Gets or sets the category collision mode selection behavior to use for the series.

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

CloseMemberAsLegendLabel

Gets or sets the label displayed before series' Close value in the Data Legend.

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

CloseMemberAsLegendUnit

Gets or sets the unit displayed after series' Close value in the Data Legend.

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

DisplayType

Gets or sets the display type for the current FinancialPriceSeries object.

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

HighMemberAsLegendLabel

Gets or sets the label displayed before series' High value in the Data Legend.

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

HighMemberAsLegendUnit

Gets or sets the unit displayed after series' High value in the Data Legend.

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

LowMemberAsLegendLabel

Gets or sets the label displayed before series' Low value in the Data Legend.

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

LowMemberAsLegendUnit

Gets or sets the unit displayed after series' Low value in the Data Legend.

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

NegativeOutline

Brush to use for outlining negative elements in the series.

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

OpenMemberAsLegendLabel

Gets or sets the label displayed before series' Open value in the Data Legend.

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

OpenMemberAsLegendUnit

Gets or sets the unit displayed after series' Open value in the Data Legend.

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

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

Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current FinancialPriceSeries object.

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 FinancialPriceSeries 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 financial 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

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

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

GetItemSpan()

Declaration
public override double GetItemSpan()
Returns
Type Description
System.Double
Overrides

GetItemSpanAsync()

For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.

Declaration
public override Task<double> GetItemSpanAsync()
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

GetSeriesValueType(ValueLayerValueMode)

Declaration
public override double[] GetSeriesValueType(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode
Returns
Type Description
System.Double[]
Overrides

GetSeriesValueTypeAsync(ValueLayerValueMode)

Gets a numeric value from the numeric axis associated with this series that matches the desired value mode.

Declaration
public override Task<double[]> GetSeriesValueTypeAsync(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode

The type of value desired from the series numeric axis.
Returns
Type Description
System.Threading.Tasks.Task<System.Double[]>
Overrides

GetSeriesValueTypePosition(ValueLayerValueMode)

Declaration
public override Point GetSeriesValueTypePosition(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode
Returns
Type Description
Point
Overrides

GetSeriesValueTypePositionAsync(ValueLayerValueMode)

Declaration
public override Task<Point> GetSeriesValueTypePositionAsync(ValueLayerValueMode mode)
Parameters
Type Name Description
ValueLayerValueMode mode
Returns
Type Description
System.Threading.Tasks.Task<Point>
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 categorySeries is scrolled by the minimum amount required to place the specified data item within the central 80% of the visible axis.

SetNegativeColors(String, String)

Declaration
public override void SetNegativeColors(string negativeBrush, string negativeOutline)
Parameters
Type Name Description
System.String negativeBrush
System.String negativeOutline
Overrides

SetNegativeColorsAsync(String, String)

Declaration
public override Task SetNegativeColorsAsync(string negativeBrush, string negativeOutline)
Parameters
Type Name Description
System.String negativeBrush
System.String negativeOutline
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Implements

System.IDisposable