Home | Class Index

SDK Version: 3.5.1-269053

Documentation generated on 03 September 2013

Interface
caplin.chart.series

Listener

The class is still an Alpha release. It should only be used for experimental development as substantial changes may occur.
An interface that caplin.chart.Component must implement if it wishes to use the the caplin.chart.Series. The interface provides callback methods that will be called when chart series data comes in.

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

Constructor Summary

Attributes Name and Description
caplin.chart.series.Listener()

Method Summary

Attributes Name and Description
void onSeriesData( sSeriesId, pData, bReset)

Notification method called by caplin.chart.Series when new series data is available.
void onSeriesError( sSeriesId, sError)

Notification method called by caplin.chart.Series when a subscription error occurs.
void onSeriesStatusUpdate( sSeriesId, sStatus)

Notification method called by caplin.chart.Series on subscription status change.

Constructor Detail

► caplin.chart.series.Listener()

Method Detail

► void onSeriesData( sSeriesId, pData, bReset)

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

Parameters
sSeriesId {String} The series ID of the new data.
pData {Array} Chart series data.
bReset {Boolean} A boolean indicating whether the chart should remove existing data and add it again.

► void onSeriesError( sSeriesId, sError)

Notification method called by caplin.chart.Series when a subscription error occurs.

Parameters
sSeriesId {String} The series ID on which an error occurred.
sError {String} A string description of the error.

► void onSeriesStatusUpdate( sSeriesId, sStatus)

Notification method called by caplin.chart.Series on subscription status change.

Parameters
sSeriesId {String} The series ID on which a status updated.
sStatus {String} A string description of the status.