Class KeltnerChannels

Keltner Channels consist of three lines: an Exponential Moving Average line, and volatility based channel lines above and below it. Average True Range is used for the volatility lines. Keltner Channels are used to follow trends and notice reversals in price.

Hierarchy

IndicatorBase
- KeltnerChannels

Index

Constructors

Methods

dispose getName setFillColor setFillEnabled setLineColor setLineWidth setMultiplier setName setOffset setPeriodCounts setValueLabelType setVisible

Constructors

constructor

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

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 all the indicator lines.
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

setMultiplier

setMultiplier(newMultiplier): void
Sets the multiplier for Average True Range.
Parameters
- newMultiplier: number
  
  New multiplier.
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

setPeriodCounts

setPeriodCounts(periodCountEMA, periodCountATR): void
Sets time period counts for Exponential Moving Average and Average True Range used in Keltner Channels calculations.
Parameters
- periodCountEMA: number
  
  EMA period count.
- periodCountATR: number
  
  ATR 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