Class CorrelationCoefficient

Correlation Coefficient measures the correlation between two securities, that is the linear relationship between the two variables. Correlation Coefficient ranges from -1 to 1, -1 meaning perfect negative correlation and 1 meaning perfect positive correlation. 0 means no linear correlation.

Hierarchy

Constructors

constructor

Methods

dispose getName setDataset setLineColor setLineWidth setName setOffset setPeriodCount setSource setSymbol setValueLabelType setVisible showMenu

Constructors

constructor

  • Parameters

    • priceChart: TradingChart
    • chart: ChartXY<UIBackground>
    • openValues: number[]
    • highValues: number[]
    • lowValues: number[]
    • closeValues: number[]
    • periodCount: number
    • lineColor: Color
    • lineWidth: number
    • rowIndex: number

    Returns CorrelationCoefficient

Methods

dispose

getName

  • Gets the indicator name.

    Returns string

    The indicator name.

setDataset

  • Adds a new dataset to the Correlation Coefficient. The main dataset will be compared to this set.

    Parameters

    • dataset: XOHLC[]

      An array of OHLC-values. Uses the same date time values as the main dataset.

    Returns void

setLineColor

  • Sets the line color of the indicator.

    Parameters

    • newColor: string

      New line color as string, should be in HEX format e.g. #FFFFFF.

    Returns void

setLineWidth

  • Sets the line width of the indicator.

    Parameters

    • newWidth: number

      New line width.

    Returns void

setName

  • Sets the name of the indicator.

    Parameters

    • name: string

      New indicator name.

    Returns void

setOffset

  • Moves the indicator from its calculated position forward or backward.

    Parameters

    • newOffset: number

      New offset value.

    Returns void

setPeriodCount

  • Sets the number of time periods (n) used to calculate the indicator.

    Parameters

    • newPeriodCount: number

      New period count.

    Returns void

setSource

  • Sets which values the indicator calculations are based on.

    Parameters

    • source: Source

      Values to base the calculations on.

    Returns void

setSymbol

  • Sets the symbol name in the indicator title.

    Parameters

    • symbol: string

      Symbol name.

    Returns Promise<void>

setValueLabelType

  • Sets the type of the indicator's value label(s).

    Parameters

    Returns void

setVisible

  • Sets the visibility of the indicator. Hiding the indicator via setVisible(false) does not remove it. Use dispose() to delete any indicator.

    Parameters

    • visible: boolean

      Visibility of the indicator.

    Returns void

showMenu

  • Programmatically opens the indicator settings menu.

    Returns void

Settings

Member Visibility

Theme