Class HistoricalVolatilityIndex

Historical Volatility Index (HVI) is an annualized volatility level of single period returns.

Hierarchy

IndicatorBase
- HistoricalVolatilityIndex

Index

Constructors

Methods

dispose getName setLineColor setLineWidth setName setOffset setPeriodCount setPeriodsPerYear setSource setStandardDeviations setUseMovingAverage setValueLabelType setVisible showMenu

Constructors

constructor

new HistoricalVolatilityIndex(priceChart, chart, openValues, highValues, lowValues, closeValues, lineColor, lineWidth, rowIndex): HistoricalVolatilityIndex
Parameters
- priceChart: TradingChart
- chart: ChartXY<UIBackground>
- openValues: number[]
- highValues: number[]
- lowValues: number[]
- closeValues: number[]
- lineColor: Color
- lineWidth: number
- rowIndex: number
Returns HistoricalVolatilityIndex

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

setLineColor

setLineColor(newColor): void
Sets the line color of the indicator.
Parameters
- newColor: string
  
  New line color as string, should be in HEX format e.g. #FFFFFF.
Returns void

setLineWidth

setLineWidth(newWidth): void
Sets the line width of the indicator.
Parameters
- newWidth: number
  
  New line width.
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 time periods (n) used to calculate the indicator.
Parameters
- newPeriodCount: number
  
  New period count.
Returns void

setPeriodsPerYear

setPeriodsPerYear(newPeriodCount): void
Sets the number of time periods used for annualizing the indicator.
Parameters
- newPeriodCount: number
  
  New period count.
Returns void

setSource

setSource(source): void
Sets which values the indicator calculations are based on.
Parameters
- source: Source
  
  Values to base the calculations on.
Returns void

setStandardDeviations

setStandardDeviations(standardDeviations): void
Sets the number of standard deviations used in calculations.
Parameters
- standardDeviations: number
  
  Multiplier for standard deviations.
Returns void

setUseMovingAverage

setUseMovingAverage(useMovingAverage): void
Sets whether Simple Moving average is used to smooth the standard deviations values during the calculations.
Parameters
- useMovingAverage: boolean
  
  Set true to use moving average.
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

showMenu

showMenu(): void
Programmatically opens the indicator settings menu.

Returns void