Class IgbFinancialCalculationDataSource
Represents the data contract between a financial series and the decoupled calculation responsibilities which implement its mathmatical logic.
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbFinancialCalculationDataSource : BaseRendererElement, JsonSerializable
Remarks
The FinancialCalculationDataSource contract represents the subset of data which needs to be provided in order to test or run a calculation, and its intentionally a subset of the information available to the series, in order to make calculation strategies more easily testable and usable in isolation to the financial series container.
Constructors
IgbFinancialCalculationDataSource()
Declaration
public IgbFinancialCalculationDataSource()
Properties
CalculateCount
The number of items from the starting index from which to calculate
Declaration
public int CalculateCount { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
CalculateFrom
The starting index from which to calculate
Declaration
public int CalculateFrom { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Count
The count of the values in the series.
Declaration
public int Count { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
LongPeriod
The long period to use when calculating, if applicable.
Declaration
public int LongPeriod { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
MaximumValue
If the calculation determines the range of indicator values, it will set the minimum and maximux properties.
Declaration
public double MaximumValue { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double |
Remarks
This will contain the previous minimum value when the indicator calculation is called again, in case this makes the update of the value speedier.
MinimumValue
If the calculation determines the range of indicator values, it will set the minimum and maximux properties.
Declaration
public double MinimumValue { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double |
Remarks
This will contain the previous minimum value when the indicator calculation is called again, in case this makes the update of the value speedier.
Multiplier
If the calculation supports some sort of scaling factor, this value will be used.
Declaration
public double Multiplier { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double |
Period
The period to use when calculating, if applicable.
Declaration
public int Period { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
ShortPeriod
The short period to use when calculating, if applicable.
Declaration
public int ShortPeriod { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
SpecifiesRange
The calculation strategy should set this to true if it specifes the minimum and maximum value properties.
Declaration
public bool SpecifiesRange { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TrueLow
An enumerable list of true low values provided by the series to use in calculations.
Declaration
public IgbCalculatedColumn TrueLow { get; set; }
Property Value
| Type | Description |
|---|---|
| IgbCalculatedColumn |
TrueRange
And enumerable list of true range values provided by the series to use in calculations.
Declaration
public IgbCalculatedColumn TrueRange { get; set; }
Property Value
| Type | Description |
|---|---|
| IgbCalculatedColumn |
Type
Declaration
public override string Type { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
TypicalColumn
An enumerable list of typical prices provided by the series to use in calculations.
Declaration
public IgbCalculatedColumn TypicalColumn { get; set; }
Property Value
| Type | Description |
|---|---|
| IgbCalculatedColumn |
Methods
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Returns
| Type | Description |
|---|---|
| System.Object |