JSDoc: Class: module:caplin/chart/study/MACD

Class: module:caplin/chart/study/MACD

module:caplin/chart/study/MACD

Constructor

new module:caplin/chart/study/MACD(alias, derivationParams, listener, configOverridesopt)

Constructs a new caplin.chart.study.MACD. A study that calculates the MACD technical analysis indicator.

This study requires the period (default 9, fasterPeriod (default 12) and slowerPeriod (default 26) to be passed in the derivation options. By default it will use the `close` field as the value for calculating the study data. If you require a different field, set a `field` property in the derivation options. See module:caplin/chart/series/Fields for details.

This study is aliased by the caplin.chart-macd-study alias. To create a new instance of this study use the module:caplin/chart/study/Factory.

Parameters:

Name	Type	Attributes	Description
`alias`	String		The Study alias.
`derivationParams`	Object		Study derivation options.
`listener`	Object		A listener object that implements the `module:caplin/chart/study/StudyListener` interface.
`configOverrides`	Object	<optional>	Configuration overrides passed to the parent class. This study overrides the `representationTypes`, `representationNames`, `isolate` and `colors` options.

Implements:

Methods

evaluate(data)

Calculates the MACD study over the given periods.

Once completed it will invoke the module:caplin/chart/study/StudyListener#onStudyData method on its listener.

The format of the calculated data is: [[timestamp, macd, signal, histogram], ...]

Parameters:

Name	Type	Description
`data`	Array	Chart series data in the Caplin Format.

See:

module:caplin/chart/Study