Class BollingerBand

Bollinger Band calculates a moving average line and then adds two more lines, one above and one below, based on a set number of standard deviation levels.

Hierarchy

Constructors

constructor

Methods

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

Constructors

constructor

  • Parameters

    • priceChart: TradingChart
    • chart: ChartXY<UIBackground>
    • openValues: number[]
    • highValues: number[]
    • lowValues: number[]
    • closeValues: number[]
    • periodCount: number
    • numberOfStandardDeviations: number
    • lineColor: Color
    • lineWidth: number
    • fillColor: Color

    Returns BollingerBand

Methods

dispose

getName

  • Gets the indicator name.

    Returns string

    The indicator name.

setFillColor

  • Sets the fill color of the Bollinger Band area.

    Parameters

    • newColor: string

      New line color as string, should be in HEX format e.g. #FFFFFF.

    Returns void

setFillEnabled

  • 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

  • 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

  • Sets the width of all the indicator lines.

    Parameters

    • newWidth: number

      New line width.

    Returns void

setName

  • Sets the name of the indicator.

    Parameters

    • name: string

      New indicator name.

    Returns void

setOffset

  • Moves the indicator from its calculated position forward or backward.

    Parameters

    • newOffset: number

      New offset value.

    Returns void

setPeriodCount

  • Sets the number of time periods (n) used to calculate the indicator.

    Parameters

    • newPeriodCount: number

      New period count.

    Returns void

setSource

  • Sets which values the indicator calculations are based on.

    Parameters

    • source: Source

      Values to base the calculations on.

    Returns void

setStandardDeviationNumber

  • Sets the number of standard deviations between the moving average line and the upper and the lower bands. Default value 2.

    Parameters

    • standardDeviationNumber: number

      New number of standard deviations.

    Returns void

setValueLabelType

  • Sets the type of the indicator's value label(s).

    Parameters

    Returns void

setVisible

  • 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

Settings

Member Visibility

Theme