Class AverageDirectionalIndex

Average Directional Index (ADX) measures the overall strength of a trend by calculating the average of expanding price range values. Directional Movement Indicators (-DI and +DI) can be shown together with the ADX line. The indicator uses Wilder's smoothing techniques.

Hierarchy

Constructors

constructor

Methods

dispose getName setDiMinusColor setDiPlusColor setLineColor setLineWidth setName setOffset setPeriodCount setValueLabelType setVisible showDiLines showMenu

Constructors

constructor

  • Parameters

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

    Returns AverageDirectionalIndex

Methods

dispose

getName

  • Gets the indicator name.

    Returns string

    The indicator name.

setDiMinusColor

  • Sets the line color of the -DI line.

    Parameters

    • newColor: string

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

    Returns void

setDiPlusColor

  • Sets the line color of the +DI line.

    Parameters

    • newColor: string

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

    Returns void

setLineColor

  • Sets the line color of the ADX line.

    Parameters

    • newColor: string

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

    Returns void

setLineWidth

  • Sets the line width of the indicator.

    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

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

showDiLines

  • Control whether -DI and +DI lines should be displayed.

    Parameters

    • showDiLines: boolean

      Set true to show DI lines.

    Returns void

showMenu

  • Programmatically opens the indicator settings menu.

    Returns void

Settings

Member Visibility

Theme