Caplin Trader 5.1.0

Interface: module:ct-chart/series/SeriesListener

module:ct-chart/series/SeriesListener

An interface that Chart must implement if it wishes to use the Series. The interface provides callback methods that will be invoked when chart series data is received.

Chart components should have a map to keep track of the series they are displaying.

Methods

onSeriesData(seriesId, data, reset)

Notification method called by Series when new series data is available.

Parameters:
Name Type Description
seriesId String

The series ID of the new data.
data Array

Chart series data.
reset Boolean

Indicates whether the chart should remove existing data and add it again.

onSeriesError(seriesId, sError)

Notification method called by Series when a subscription error occurs.

Parameters:
Name Type Description
seriesId String

The series ID on which an error occurred.
sError String

A string description of the error.

onSeriesStatusUpdate(seriesId, sStatus)

Notification method called by Series on subscription status change.

Parameters:
Name Type Description
seriesId String

The series ID on which a status updated.
sStatus String

A string description of the status.