Class LinearRegression

Linear Regression plots a trendline value for each data point using least squares method. The indicator consists of four lines: slope, intercept, forecast and R squared. Of these slope and R squared are displayed in their own segments while intercept and forecast share one segment.

Hierarchy

Constructors

constructor

Methods

dispose getName setLineColor setLineWidth setName setOffset setPeriodCount setSource 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
    • id: string = ''

    Returns LinearRegression

Methods

dispose

getName

  • Gets the indicator name.

    Returns string

    The indicator name.

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

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