Class IgbFinancialSeries
Represents the base class for all financial indicator and overlay series.
Inheritance
System.Object
IgbFinancialSeries
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbFinancialSeries : IgbSeries, JsonSerializable, IDisposable
Constructors
IgbFinancialSeries()
Declaration
public IgbFinancialSeries()
Properties
AssigningCategoryStyle
Declaration
public Action<IgbAssigningCategoryStyleEventArgs> AssigningCategoryStyle { get; set; }
Property Value
AssigningCategoryStyleScript
Declaration
public string AssigningCategoryStyleScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CloseMemberPath
Gets or sets the close mapping property for the current series object.
Declaration
public string CloseMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HighlightedCloseMemberPath
Declaration
public string HighlightedCloseMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HighlightedHighMemberPath
Declaration
public string HighlightedHighMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HighlightedLowMemberPath
Declaration
public string HighlightedLowMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HighlightedOpenMemberPath
Declaration
public string HighlightedOpenMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HighlightedVolumeMemberPath
Declaration
public string HighlightedVolumeMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HighMemberPath
Gets or sets the high mapping property for the current series object.
Declaration
public string HighMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
IsCustomCategoryStyleAllowed
Gets or sets whether this category series should allow custom style overrides of its individual visuals.
Declaration
public bool IsCustomCategoryStyleAllowed { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
IsTransitionInEnabled
Gets or sets whether the series should transition into the plot area when a new data source is assigned.
Note: Transitions are not currently supported for stacked series.
Declaration
public bool IsTransitionInEnabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
LowMemberPath
Gets or sets the low mapping property for the current series object.
Declaration
public string LowMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
NegativeBrush
Gets or sets the brush to use for negative portions of the series.
Declaration
public string NegativeBrush { get; set; }
Property Value
| Type |
Description |
| System.String |
|
OpenMemberPath
Gets or sets the open mapping property for the current series object.
Declaration
public string OpenMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TransitionInMode
Gets or sets the method by which to animate the data into the chart when the chart data source is swapped.
Note: Transitions are not currently supported for stacked series.
Declaration
public CategoryTransitionInMode TransitionInMode { get; set; }
Property Value
Type
Declaration
public override string Type { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
Typical
Declaration
public EventCallback<IgbFinancialEventArgs> Typical { get; set; }
Property Value
TypicalBasedOn
Declaration
public EventCallback<IgbFinancialEventArgs> TypicalBasedOn { get; set; }
Property Value
TypicalBasedOnScript
Declaration
public string TypicalBasedOnScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TypicalScript
Declaration
public string TypicalScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
VolumeMemberPath
Gets or sets the volume mapping property for the current series object.
Declaration
public string VolumeMemberPath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
XAxis
Gets or sets the effective x-axis for the current FinancialSeries object.
Declaration
public IgbCategoryAxisBase XAxis { get; set; }
Property Value
XAxisName
Gets or sets the name to use to resolve xAxis from markup.
Declaration
public string XAxisName { get; set; }
Property Value
| Type |
Description |
| System.String |
|
XAxisScript
Provides a means of setting XAxis in the JavaScript environment.
Declaration
public string XAxisScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
YAxis
Gets or sets the effective y-axis for the current FinancialSeries object.
Declaration
public IgbNumericYAxis YAxis { get; set; }
Property Value
YAxisName
Gets or sets the name to use to resolve yAxis from markup.
Declaration
public string YAxisName { get; set; }
Property Value
| Type |
Description |
| System.String |
|
YAxisScript
Provides a means of setting YAxis in the JavaScript environment.
Declaration
public string YAxisScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Methods
BindAxes(IgbAxis[])
Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
| Type |
Name |
Description |
| IgbAxis[] |
Axes |
|
Overrides
CanUseAsXAxis(Object)
Declaration
public bool CanUseAsXAxis(object axis)
Parameters
| Type |
Name |
Description |
| System.Object |
axis |
|
Returns
| Type |
Description |
| System.Boolean |
|
CanUseAsXAxisAsync(Object)
Determine if object can be used as XAxis
Declaration
public Task<bool> CanUseAsXAxisAsync(object axis)
Parameters
| Type |
Name |
Description |
| System.Object |
axis |
The object to check
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Boolean> |
|
CanUseAsYAxis(Object)
Declaration
public bool CanUseAsYAxis(object axis)
Parameters
| Type |
Name |
Description |
| System.Object |
axis |
|
Returns
| Type |
Description |
| System.Boolean |
|
CanUseAsYAxisAsync(Object)
Determine if object can be used as YAxis
Declaration
public Task<bool> CanUseAsYAxisAsync(object axis)
Parameters
| Type |
Name |
Description |
| System.Object |
axis |
The object to check
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Boolean> |
|
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
| Type |
Description |
| System.Object |
|
Overrides
GetCategoryWidth()
Declaration
public double GetCategoryWidth()
Returns
| Type |
Description |
| System.Double |
|
GetCategoryWidthAsync()
Returns the width of the category grouping this series is in.
Declaration
public Task<double> GetCategoryWidthAsync()
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Double> |
|
GetExactItemIndex(Point)
Declaration
public override double GetExactItemIndex(Point world)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
Returns
| Type |
Description |
| System.Double |
|
Overrides
GetExactItemIndexAsync(Point)
Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.
Declaration
public override Task<double> GetExactItemIndexAsync(Point world)
Parameters
| Type |
Name |
Description |
| Point |
world |
The world position for which to return the index.
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Double> |
|
Overrides
GetItem(Point)
Declaration
public override object GetItem(Point world)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
Returns
| Type |
Description |
| System.Object |
|
Overrides
GetItemAsync(Point)
Gets the item that is the best match for the specified world coordinates.
Declaration
public override Task<object> GetItemAsync(Point world)
Parameters
| Type |
Name |
Description |
| Point |
world |
The world coordinates to use.
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Object> |
|
Overrides
GetItemIndex(Point)
Declaration
public override int GetItemIndex(Point world)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
Returns
| Type |
Description |
| System.Int32 |
|
Overrides
GetItemIndexAsync(Point)
Gets the index of the item that resides at the provided world coordinates.
Declaration
public override Task<int> GetItemIndexAsync(Point world)
Parameters
| Type |
Name |
Description |
| Point |
world |
The world coordinates of the requested item.
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Int32> |
|
Overrides
GetItemValue(Object, String)
Declaration
public override object GetItemValue(object item, string memberPathName)
Parameters
| Type |
Name |
Description |
| System.Object |
item |
|
| System.String |
memberPathName |
|
Returns
| Type |
Description |
| System.Object |
|
Overrides
GetItemValueAsync(Object, String)
Declaration
public override Task<object> GetItemValueAsync(object item, string memberPathName)
Parameters
| Type |
Name |
Description |
| System.Object |
item |
|
| System.String |
memberPathName |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Object> |
|
Overrides
GetMemberPathValue(String)
Declaration
public override string GetMemberPathValue(string memberPathName)
Parameters
| Type |
Name |
Description |
| System.String |
memberPathName |
|
Returns
| Type |
Description |
| System.String |
|
Overrides
GetMemberPathValueAsync(String)
Declaration
public override Task<string> GetMemberPathValueAsync(string memberPathName)
Parameters
| Type |
Name |
Description |
| System.String |
memberPathName |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.String> |
|
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
GetOffsetValue()
Declaration
public double GetOffsetValue()
Returns
| Type |
Description |
| System.Double |
|
GetOffsetValueAsync()
Returns the offset value for this series if grouped on a category axis.
Declaration
public Task<double> GetOffsetValueAsync()
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Double> |
|
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
GetSeriesCloseValue(Point, Boolean, Boolean)
Declaration
public virtual double GetSeriesCloseValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
| Type |
Description |
| System.Double |
|
GetSeriesCloseValueAsync(Point, Boolean, Boolean)
Declaration
public virtual Task<double> GetSeriesCloseValueAsync(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> |
|
GetSeriesCloseValuePosition(Point, Boolean, Boolean)
Declaration
public virtual Point GetSeriesCloseValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
GetSeriesCloseValuePositionAsync(Point, Boolean, Boolean)
Declaration
public virtual Task<Point> GetSeriesCloseValuePositionAsync(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<Point> |
|
GetSeriesHighValue(Point, Boolean, Boolean)
Declaration
public override double GetSeriesHighValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
| Type |
Description |
| System.Double |
|
Overrides
GetSeriesHighValueAsync(Point, Boolean, Boolean)
Declaration
public override Task<double> GetSeriesHighValueAsync(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
GetSeriesHighValuePosition(Point, Boolean, Boolean)
Declaration
public override Point GetSeriesHighValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
Overrides
GetSeriesHighValuePositionAsync(Point, Boolean, Boolean)
Declaration
public override Task<Point> GetSeriesHighValuePositionAsync(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<Point> |
|
Overrides
GetSeriesLowValue(Point, Boolean, Boolean)
Declaration
public override double GetSeriesLowValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
| Type |
Description |
| System.Double |
|
Overrides
GetSeriesLowValueAsync(Point, Boolean, Boolean)
Declaration
public override Task<double> GetSeriesLowValueAsync(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
GetSeriesLowValuePosition(Point, Boolean, Boolean)
Declaration
public override Point GetSeriesLowValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
Overrides
GetSeriesLowValuePositionAsync(Point, Boolean, Boolean)
Declaration
public override Task<Point> GetSeriesLowValuePositionAsync(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<Point> |
|
Overrides
GetSeriesOpenValue(Point, Boolean, Boolean)
Declaration
public virtual double GetSeriesOpenValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
| Type |
Description |
| System.Double |
|
GetSeriesOpenValueAsync(Point, Boolean, Boolean)
Declaration
public virtual Task<double> GetSeriesOpenValueAsync(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> |
|
GetSeriesOpenValuePosition(Point, Boolean, Boolean)
Declaration
public virtual Point GetSeriesOpenValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
GetSeriesOpenValuePositionAsync(Point, Boolean, Boolean)
Declaration
public virtual Task<Point> GetSeriesOpenValuePositionAsync(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<Point> |
|
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
GetSeriesValuePosition(Point, Boolean, Boolean)
Declaration
public override Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
Overrides
GetSeriesValuePositionAsync(Point, Boolean, Boolean)
Declaration
public override Task<Point> GetSeriesValuePositionAsync(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<Point> |
|
Overrides
GetSeriesVolumeValue(Point, Boolean, Boolean)
Declaration
public virtual double GetSeriesVolumeValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
| Type |
Description |
| System.Double |
|
GetSeriesVolumeValueAsync(Point, Boolean, Boolean)
Declaration
public virtual Task<double> GetSeriesVolumeValueAsync(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> |
|
GetSeriesVolumeValuePosition(Point, Boolean, Boolean)
Declaration
public virtual Point GetSeriesVolumeValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
| Type |
Name |
Description |
| Point |
world |
|
| System.Boolean |
useInterpolation |
|
| System.Boolean |
skipUnknowns |
|
Returns
GetSeriesVolumeValuePositionAsync(Point, Boolean, Boolean)
Declaration
public virtual Task<Point> GetSeriesVolumeValuePositionAsync(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<Point> |
|
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