Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.chart

Chart

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 seriesRequest)

Adds a new series to the chart component.
Object addStudy(String seriesId, String alias, String derivationParams, Object adapter)

Adds a new study to the chart component.
void hideStudy(String seriesId, String studyId)

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

Removes a series from the chart component.
void removeStudy(String seriesId, String studyId)

Removes a study from the chart component.
void showStudy(String seriesId, String studyId)

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

Constructor Detail

► caplin.chart.Chart()

Method Detail

► String addSeries(Object seriesRequest)

Adds a new series to the chart component.

Parameters
Object seriesRequest 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 seriesId, String alias, String derivationParams, Object adapter)

Adds a new study to the chart component. This method is optional and doesn't need to be implemented.

Parameters
String seriesId The ID of the series to which to add the study.
String alias Alias under which the study class is aliased.
String derivationParams Map of derivation options for the study. See caplin.chart.Study for details.
Object adapter (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 seriesId, String studyId)

Hide the study on the chart. This method is optional and doesn't need to be implemented.

Parameters
String seriesId ID of the series that has the study.
String studyId ID of the study to hide.

► void removeSeries(String seriesId)

Removes a series from the chart component.

Parameters
String seriesId The ID of the series to remove.

► void removeStudy(String seriesId, String studyId)

Removes a study from the chart component. This method is optional and doesn't need to be implemented.

Parameters
String seriesId ID of the series that has the study.
String studyId ID of the study to remove.

► void showStudy(String seriesId, String studyId)

Show the study on the chart. This method is optional and doesn't need to be implemented.

Parameters
String seriesId ID of the series that has the study.
String studyId ID of the study to show.