Class VolumeOscillator

Volume Oscillator (VO) is a momentum oscillator for Volume, that works similarly to MACD. VO can be used to confirm or refute other signals. VO line is the difference between the selected moving average of short period data and long period data. Signal line is Signal period moving average of VO. Histogram shows the difference between VO and Signal.

Hierarchy

Constructors

constructor

Methods

dispose getName setCalculateAsPercentage setHistogramColor setLineWidth setMovingAverageSignal setMovingAverageType setName setOffset setPeriodCounts setSignalLineColor setVOLineColor setValueLabelType setVisible showMenu

Constructors

constructor

  • Parameters

    • priceChart: TradingChart
    • chart: ChartXY<UIBackground>
    • volumes: number[]
    • shortPeriodCount: number
    • longPeriodCount: number
    • signalPeriodCount: number
    • voColor: Color
    • signalColor: Color
    • histogramColor: Color
    • lineWidth: number
    • rowIndex: number

    Returns VolumeOscillator

Methods

dispose

getName

  • Gets the indicator name.

    Returns string

    The indicator name.

setCalculateAsPercentage

  • Sets whether the difference between the short and long moving averages is calculated as a percentage and instead as an actual volume difference.

    Parameters

    • calculateAsPercentage: boolean

      Set true calculate as a percentage.

    Returns void

setHistogramColor

  • Sets the color for the Histogram.

    Parameters

    • histogramColor: string

      Color for the Histogram.

    Returns void

setLineWidth

  • Sets the width of the VO and Signal lines.

    Parameters

    • newWidth: number

      New line width.

    Returns void

setMovingAverageSignal

  • Sets the type of Moving Average used to calculate the Signal line.

    Parameters

    Returns void

setMovingAverageType

  • Sets the type of Moving Average used to calculate the short and long averages.

    Parameters

    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

setPeriodCounts

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

    Parameters

    • shortPeriodCount: number

      New short period count.

    • longPeriodCount: number

      New long period count.

    • signalPeriodCount: number

      New signal period count.

    Returns void

setSignalLineColor

  • Sets the color of the Signal line.

    Parameters

    • newColor: string

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

    Returns void

setVOLineColor

  • Sets the color of the Volume Oscillator line.

    Parameters

    • newColor: string

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

    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

showMenu

  • Programmatically opens the indicator settings menu.

    Returns void

Settings

Member Visibility

Theme