This study requires no derivation options. By default it will use the `volume` field as the value for calculating the study data. If you require a different field, set a `field` property in the derivation options. See caplin.chart.series.Fields for details.
This study is aliased by the caplin.chart-volume-study
alias. To create a new instance of this study
use the caplin.chart.study.Factory.
Attributes | Name and Description |
---|---|
|
caplin.chart.study.Volume(Object sAlias, Object mDerivationParams, Object oListener, Object mConfigOverrides)
Constructs a new |
Attributes | Name and Description |
---|---|
|
void
evaluate(Array pData)
Extracts the volume data from the inbound series data. |
►
caplin.chart.study.Volume(Object sAlias, Object mDerivationParams, Object oListener, Object mConfigOverrides)
Constructs a new caplin.chart.study.Volume
.
Object | sAlias | The Study alias. |
Object | mDerivationParams | Study derivation options. |
Object | oListener | A listener object that implements the caplin.chart.study.StudyListener interface. |
Object | mConfigOverrides | (optional) Configuration overrides passed to the parent class. This study overrides
the representationTypes and isolate options. |
►
void
evaluate(Array pData)
Extracts the volume data from the inbound series data.
Once completed it will invoke the caplin.chart.study.StudyListener#onStudyData method on its listener.
The format of the calculated data is: [[timestamp, volume], ...]
Array | pData | Chart series data in the Caplin Format. |