Class HighLowBands

High Low Bands consist of three lines: a Triangular Moving Average line, and upper and lower band lines based on specific percentage of the average line. High Low Bands can be used to identify bullish and bearish trends.

Hierarchy

IndicatorBase
- HighLowBands

Index

Constructors

Methods

dispose getName setFillColor setFillEnabled setLineColor setLineWidth setName setOffset setPercentage setPeriodCount setSource setValueLabelType setVisible

Constructors

constructor

new HighLowBands(priceChart, chart, openValues, highValues, lowValues, closeValues, periodCount): HighLowBands
Parameters
- priceChart: TradingChart
- chart: ChartXY<UIBackground>
- openValues: number[]
- highValues: number[]
- lowValues: number[]
- closeValues: number[]
- periodCount: number
Returns HighLowBands

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

setFillColor

setFillColor(newColor): void
Sets the fill color of the area between the upper and lower bands.
Parameters
- newColor: string
  
  New line color as string, should be in HEX format e.g. #FFFFFF.
Returns void

setFillEnabled

setFillEnabled(fillEnabled): void
Sets whether the area between the upper and lower bands should be colored. Use setFillColor() -method to modify the fill color.
Parameters
- fillEnabled: boolean
  
  Set true to enable coloring.
Returns void

setLineColor

setLineColor(newColor): void
Sets the color of the middle 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 width of all the indicator lines.
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

setPercentage

setPercentage(newPercentage): void
Sets the percentage of the TMA line to position the upper and lower bands.
Parameters
- newPercentage: number
  
  New percentage.
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

setSource

setSource(source): void
Sets which values the indicator calculations are based on.
Parameters
- source: Source
  
  Values to base the calculations on.
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