Home | Class Index

SDK Version: 3.5.2-271820

Documentation generated on 13 September 2013

Package
caplin.chart.study

Factory

The class is still in Beta and is subject to API changes.
A static class that is used to construct new study objects.

You will use this factory if you are creating a new study that internally uses another study.

Constructor Summary

Attributes Name and Description
caplin.chart.study.Factory()

Method Summary

Attributes Name and Description
<static> Object createStudy(String sStudyAlias, Object oOptions, Object oListener, Object oEmitter)

Instantiates a new study object based on the provided alias.

Constructor Detail

► caplin.chart.study.Factory()

Method Detail

► <static> Object createStudy(String sStudyAlias, Object oOptions, Object oListener, Object oEmitter)

Instantiates a new study object based on the provided alias.

Parameters
String sStudyAlias The study alias, to be retrieved from the AliasRegistry
Object oOptions An object literal containing the options for to the study
Object oListener The listener for the study data
Object oEmitter An optional output emitter override
Throws
caplin.core.Error
if the study alias is invalid
Returns
{Object} caplin.chart.Study object