Class Aroon

The Aroon indicator identifies trend changes in the price. It also reveals the strength of that trend. Consists of two lines: Aroon Up measuring the uptrend strength and Aroon Down measuring the downtrend strength.

Hierarchy

IndicatorBase
- Aroon

Index

Constructors

Methods

dispose getName setAroonDownLineColor setAroonUpLineColor setLineWidth setName setOffset setPeriodCount setValueLabelType setVisible showMenu

Constructors

constructor

new Aroon(priceChart, chart, highValues, lowValues, periodCount, lineColorUp, lineColorDown, lineWidth, rowIndex): Aroon
Parameters
- priceChart: TradingChart
- chart: ChartXY<UIBackground>
- highValues: number[]
- lowValues: number[]
- periodCount: number
- lineColorUp: Color
- lineColorDown: Color
- lineWidth: number
- rowIndex: number
Returns Aroon

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

setAroonDownLineColor

setAroonDownLineColor(newColor): void
Sets the color of the Aroon Down line.
Parameters
- newColor: string
  
  New line color as string, should be in HEX format e.g. #FFFFFF.
Returns void

setAroonUpLineColor

setAroonUpLineColor(newColor): void
Sets the color of the Aroon Up 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

setPeriodCount

setPeriodCount(newPeriodCount): void
Sets the number of time periods (n) used to calculate the indicator.
Parameters
- newPeriodCount: number
  
  New period count.
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