Home | Class Index

SDK Version: 3.5.2-271820

Documentation generated on 13 September 2013

Class
caplin.chart.study

BollingerBand

The class is still in Beta and is subject to API changes.
Implements caplin.chart.Study, caplin.chart.study.StudyListener.
A study that calculates the Bollinger Bands over the given period with upper and lower bands at n standard deviations.

This study only requires the options defined by caplin.chart.Study.

This study is aliased by the caplin.chart-bollinger-bands-study alias. To create a new instance of this study use the caplin.chart.study.Factory.

Constructor Summary

Attributes Name and Description
caplin.chart.study.BollingerBand( mOptions, oListener, oEmitter)

Constructs a new caplin.chart.study.BollingerBand.

Method Summary

Attributes Name and Description
String getAlias()

Gets the study's alias name
String getDisplayName( seriesIdx)

Gets the display name.
Methods implemented from class caplin.chart.Study:
enqueue, evaluate, getConfiguration, getId, getRepresentationNames, getRepresentationTypes
Methods implemented from class caplin.chart.study.StudyListener:
onStudyData

Constructor Detail

► caplin.chart.study.BollingerBand( mOptions, oListener, oEmitter)

Constructs a new caplin.chart.study.BollingerBand.

Parameters
mOptions
oListener
oEmitter

Method Detail

► String getAlias()

Gets the study's alias name

Returns
{String} The alias for the study
See
caplin.chart.Study

► String getDisplayName( seriesIdx)

Gets the display name. The name is constructed from the configuration options provided when constructing the study.

Parameters
seriesIdx
Returns
{String} The study display name