Represents the data contract between a financial series and the decoupled calculation responsibilities which implement its mathmatical logic. 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

Accessors

  • get calculateCount(): number
  • The number of items from the starting index from which to calculate

    Returns number

  • set calculateCount(v): void
  • Parameters

    • v: number

    Returns void

  • get calculateFrom(): number
  • The starting index from which to calculate

    Returns number

  • set calculateFrom(v): void
  • Parameters

    • v: number

    Returns void

  • get closeColumn(): number[]
  • Returns number[]

  • get count(): number
  • The count of the values in the series.

    Returns number

  • set count(v): void
  • Parameters

    • v: number

    Returns void

  • get highColumn(): number[]
  • Returns number[]

  • get i(): FinancialCalculationDataSource
  • Returns FinancialCalculationDataSource

  • get indicatorColumn(): any
  • Returns any

  • get longPeriod(): number
  • The long period to use when calculating, if applicable.

    Returns number

  • set longPeriod(v): void
  • Parameters

    • v: number

    Returns void

  • get lowColumn(): number[]
  • Returns number[]

  • get maximumValue(): number
  • If the calculation determines the range of indicator values, it will set the minimum and maximux properties. This will contain the previous minimum value when the indicator calculation is called again, in case this makes the update of the value speedier.

    Returns number

  • set maximumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get minimumValue(): number
  • If the calculation determines the range of indicator values, it will set the minimum and maximux properties. This will contain the previous minimum value when the indicator calculation is called again, in case this makes the update of the value speedier.

    Returns number

  • set minimumValue(v): void
  • Parameters

    • v: number

    Returns void

  • get multiplier(): number
  • If the calculation supports some sort of scaling factor, this value will be used.

    Returns number

  • set multiplier(v): void
  • Parameters

    • v: number

    Returns void

  • get openColumn(): number[]
  • Returns number[]

  • get period(): number
  • The period to use when calculating, if applicable.

    Returns number

  • set period(v): void
  • Parameters

    • v: number

    Returns void

  • get shortPeriod(): number
  • The short period to use when calculating, if applicable.

    Returns number

  • set shortPeriod(v): void
  • Parameters

    • v: number

    Returns void

  • get specifiesRange(): boolean
  • The calculation strategy should set this to true if it specifes the minimum and maximum value properties.

    Returns boolean

  • set specifiesRange(v): void
  • Parameters

    • v: boolean

    Returns void

  • get trueLow(): IgcCalculatedColumn
  • An enumerable list of true low values provided by the series to use in calculations.

    Returns IgcCalculatedColumn

  • set trueLow(v): void
  • Parameters

    Returns void

  • get trueRange(): IgcCalculatedColumn
  • And enumerable list of true range values provided by the series to use in calculations.

    Returns IgcCalculatedColumn

  • set trueRange(v): void
  • Parameters

    Returns void

  • get typicalColumn(): IgcCalculatedColumn
  • An enumerable list of typical prices provided by the series to use in calculations.

    Returns IgcCalculatedColumn

  • set typicalColumn(v): void
  • Parameters

    Returns void

  • get volumeColumn(): number[]
  • Returns number[]

Methods

  • Parameters

    • name: string

    Returns any