Class LinearRegressionIF

Linear Regression Intercept and Forecast lines. Added as a part of Linear Regression indicator.

Hierarchy

IndicatorBase
- LinearRegressionIF

Index

Constructors

Methods

dispose getName setForecastLineColor setInterceptLineColor setLineWidth setName setOffset setValueLabelType setVisible showMenu

Constructors

constructor

new LinearRegressionIF(priceChart, chart, closeValues, lineColorI, lineColorF, lineWidth, rowIndex, id): LinearRegressionIF
Parameters
- priceChart: TradingChart
- chart: ChartXY<UIBackground>
- closeValues: number[]
- lineColorI: Color
- lineColorF: Color
- lineWidth: number
- rowIndex: number
- id: string
Returns LinearRegressionIF

Overrides IndicatorBase.constructor

Methods

dispose

dispose(): void
Disposes the indicator.

Returns void

Overrides IndicatorBase.dispose

getName

getName(): string
Gets the indicator name.

Returns string
The indicator name.

Inherited from IndicatorBase.getName

setForecastLineColor

setForecastLineColor(newColor): void
Sets the color of the Linear Regression Forecast line.
Parameters
- newColor: string
  
  New line color as string, should be in HEX format e.g. #FFFFFF.
Returns void

setInterceptLineColor

setInterceptLineColor(newColor): void
Sets the color of the Linear Regression Intercept line.
Parameters
- newColor: string
  
  New line color as string, should be in HEX format e.g. #FFFFFF.
Returns void

setLineWidth

setLineWidth(newWidth): void
Sets the line width of the indicator.
Parameters
- newWidth: number
  
  New line width.
Returns void

setName

setName(name): void
Sets the name of the indicator.
Parameters
- name: string
  
  New indicator name.
Returns void

Inherited from IndicatorBase.setName

setOffset

setOffset(newOffset): void
Moves the indicator from its calculated position forward or backward.
Parameters
- newOffset: number
  
  New offset value.
Returns void

setValueLabelType

setValueLabelType(labelType): void
Sets the type of the indicator's value label(s).
Parameters
- labelType: ValueLabelType
  
  Value label type.
Returns void

setVisible

setVisible(visible): void
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

showMenu(): void
Programmatically opens the indicator settings menu.

Returns void