Caplin Trader 5.1.0

Interface: module:ct-chart/Chart

module:ct-chart/Chart

The interface that chart components must implement to work correctly in workbenches.

Implements:

Methods

addSeries(seriesRequest) → {String}

Adds a new series to the chart component.

Parameters:
Name Type Description
seriesRequest Object

A SeriesRequest object that will be used to construct a new Series object.
Returns:

The ID of the new series.

Type
String

addStudy(seriesId, alias, derivationParams, adapteropt) → {Object}

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

Parameters:
Name Type Attributes Description
seriesId String

The ID of the series to which to add the study.
alias String

Alias under which the study class is aliased.
derivationParams String

Map of derivation options for the Study for details.
adapter module:ct-chart/study/Adaptor <optional>

An Adapter that will be used by the Series to transform the data before it is passed back to the chart component.
Returns:

The newly added study object.

Type
Object

hideStudy(seriesId, studyId)

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

Parameters:
Name Type Description
seriesId String

ID of the series that has the study.
studyId String

ID of the study to hide.

removeSeries(seriesId)

Removes a series from the chart component.

Parameters:
Name Type Description
seriesId String

The ID of the series to remove.

removeStudy(seriesId, studyId)

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

Parameters:
Name Type Description
seriesId String

ID of the series that has the study.
studyId String

ID of the study to remove.

showStudy(seriesId, studyId)

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

Parameters:
Name Type Description
seriesId String

ID of the series that has the study.
studyId String

ID of the study to show.