Class IgbFinancialOverlay
Represents the base functionality for a IgbDataChart financial overlay series.
Inheritance
System.Object
IgbFinancialOverlay
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbFinancialOverlay : IgbFinancialSeries, JsonSerializable, IDisposableRemarks
The difference between a FinancialIndicator and a FinancialOverlay is small. Overlays are usually drawn against the same axes as the price, but they don't have to be. Overlays mostly display multiple values, but not all of them, and so so some indicators.
Constructors
IgbFinancialOverlay()
Declaration
public IgbFinancialOverlay()Properties
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 |
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
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