Class FractalChaosBands

Fractal Chaos Bands (FCB) filter out insignificant price movements by plotting the high and low price fractals as a channel. FCB can be used to tell if the market is trending.

Hierarchy

IndicatorBase
- FractalChaosBands

Index

Constructors

Methods

dispose getName setFillColor setFillEnabled setLineWidth setLowerLineColor setName setOffset setPeriodCount setUpperLineColor setValueLabelType setVisible

Constructors

constructor

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

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

setLineWidth

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

setLowerLineColor

setLowerLineColor(newColor): void
Sets the color of the lower band lines.
Parameters
- newColor: string
  
  New lower band line color as string, should be in HEX format e.g. #FFFFFF.
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 bars/candles needed to form a fractal. A new fractal is formed when n number of bars/candles before and after a High or Low peak are lower or higher respectively, where n = period count.
Parameters
- newPeriodCount: number
  
  New period count.
Returns void

setUpperLineColor

setUpperLineColor(newColor): void
Sets the color of the upper band line.
Parameters
- newColor: string
  
  New upper band line color as string, should be in HEX format e.g. #FFFFFF.
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