Home | Class Index

SDK Version: 3.5.2-271820

Documentation generated on 13 September 2013

Interface
caplin.chart

Chart

The class is still in Beta and is subject to API changes.
Implements caplin.component.Component.
The interface that chart components must implement to work correctly in workbenches.

Constructor Summary

Attributes Name and Description
caplin.chart.Chart()

Method Summary

Attributes Name and Description
String addSeries(Object oSeriesRequest)

Adds a new series to the chart component.
Object addStudy(String sSeriesId, String sStudyAlias, String oOptions, Object oStudyAdapter)

Adds a new study to the chart component.
void hideStudy(String sSeriesId, String sStudyId)

Hide the study on the chart.
void removeSeries(String sSeriesId)

Removes a series from the chart component.
void removeStudy(String sSeriesId, String sStudyId)

Removes a study from the chart component.
void showStudy(String sSeriesId, String sStudyId)

Show the study on the chart.
Methods implemented from class caplin.component.Component:
getContainer, getElement, getPermissionKey, getSerializedState, getUniqueComponentId, setContainer, setFrame

Constructor Detail

► caplin.chart.Chart()

Method Detail

► String addSeries(Object oSeriesRequest)

Adds a new series to the chart component.

Parameters
Object oSeriesRequest A caplin.chart.series.SeriesRequest object that will be used to construct a new caplin.chart.Series object
Returns
{String} The ID of the new series.

► Object addStudy(String sSeriesId, String sStudyAlias, String oOptions, Object oStudyAdapter)

Adds a new study to the chart component.

Parameters
String sSeriesId The ID of the series to which to add the study
String sStudyAlias alias under which the study class is aliased
String oOptions map of options for the study. See caplin.chart.Study for details
Object oStudyAdapter (optional) A caplin.chart.study.Adapter that will be used by the caplin.chart.Series to transform the data before it is passed back to the chart component
Returns
{Object} The newly added study object

► void hideStudy(String sSeriesId, String sStudyId)

Hide the study on the chart.

Parameters
String sSeriesId ID of the series that has the study
String sStudyId ID of the study to hide

► void removeSeries(String sSeriesId)

Removes a series from the chart component.

Parameters
String sSeriesId The ID of the series to remove

► void removeStudy(String sSeriesId, String sStudyId)

Removes a study from the chart component.

Parameters
String sSeriesId ID of the series that has the study
String sStudyId ID of the study to remove

► void showStudy(String sSeriesId, String sStudyId)

Show the study on the chart.

Parameters
String sSeriesId ID of the series that has the study
String sStudyId ID of the study to show