Home | Class Index

SDK Version: 3.5.1-269053

Documentation generated on 03 September 2013

Class
caplin.chart

Series

The class is still an Alpha release. It should only be used for experimental development as substantial changes may occur.
The Series manages data fetching from a backend system using the service aliased by caplin.chart-message-service.

Chart components construct a new caplin.chart.Series object when they wish to request new chart series data to display. If a chart component is using this class it has to implement a caplin.chart.series.Listener interface that defines the callback methods that this class will call when it has the chart data to pass on.

It will also provide derivations support in the future.

Constructor Summary

Attributes Name and Description
caplin.chart.Series(Object oSeriesRequest, Object oChartSeriesAdapter, Object oListener)

Constructs a new caplin.chart.Series.

Method Summary

Attributes Name and Description
void dispose()

This method disposes the caplin.chart.Series object.
Object getSeriesRequest()

Returns a caplin.chart.series.Request object that was passed to the constructor.

Constructor Detail

► caplin.chart.Series(Object oSeriesRequest, Object oChartSeriesAdapter, Object oListener)

Constructs a new caplin.chart.Series.

Parameters
Object oSeriesRequest A caplin.chart.series.Request object that determines what data you are requesting from the backend.
Object oChartSeriesAdapter A caplin.chart.series.Adapter object that will transform the series data into a format that the chart engine in use understands.
Object oListener A caplin.chart.series.Listener that will recieve chart data.

Method Detail

► void dispose()

This method disposes the caplin.chart.Series object. It must be called to properly close subscriptions.

► Object getSeriesRequest()

Returns a caplin.chart.series.Request object that was passed to the constructor.

Returns
{Object} A Request object.