com.googlecode.wickedcharts.highcharts.options.livedata

Class LiveDataSeries

java.lang.Object

com.googlecode.wickedcharts.highcharts.options.series.Series<Point>

com.googlecode.wickedcharts.highcharts.options.series.PointSeries

com.googlecode.wickedcharts.highcharts.options.livedata.LiveDataSeries

All Implemented Interfaces:

IProcessableOption, Serializable

public abstract class LiveDataSeries
extends PointSeries
implements IProcessableOption

This Series class supports regular updating via AJAX.

Author:

Tom Hombergs (tom.hombergs@gmail.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROCESSING_KEY The key under which LiveDataSeries are registered in the parent options.

Constructor Summary

Constructors

Constructor and Description
LiveDataSeries(Options parentOptions, int updateIntervalMs) Constructs a new LiveDataSeries.

Method Summary

Methods

Modifier and Type	Method and Description
Options	getParentOptions()
String	getProcessingKey()
int	getUpdateIntervalMs()
void	setUpdateIntervalMs(int updateIntervalMs)
abstract Coordinate<Number,Number>	update() This method is called for each update interval.

Methods inherited from class com.googlecode.wickedcharts.highcharts.options.series.PointSeries

addNumberPoint, addNumbers, getData, setData, setData, setNumberData, setNumberData

Methods inherited from class com.googlecode.wickedcharts.highcharts.options.series.Series

addPoint, getCenter, getColor, getDashStyle, getDataLabels, getEnableMouseTracking, getInnerSize, getLegendIndex, getMarker, getName, getPointInterval, getPointPlacement, getPointStart, getShowInLegend, getSize, getStack, getStates, getTooltip, getType, getWickedChartsId, getxAxis, getyAxis, setCenter, setColor, setColor, setDashStyle, setDataLabels, setEnableMouseTracking, setInnerSize, setLegendIndex, setMarker, setName, setPointInterval, setPointPlacement, setPointStart, setShowInLegend, setSize, setStack, setStates, setTooltip, setType, setWickedChartsId, setxAxis, setyAxis

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROCESSING_KEY

public static final String PROCESSING_KEY

The key under which LiveDataSeries are registered in the parent options. See Options.markForProcessing(IProcessableOption) .

See Also:

Constant Field Values

Constructor Detail

LiveDataSeries

public LiveDataSeries(Options parentOptions,
              int updateIntervalMs)

Constructs a new LiveDataSeries.

Parameters:

parentOptions - the Options to which this series are added.

updateIntervalMs - the interval in which to update the series in milliseconds.

Method Detail

getParentOptions

public Options getParentOptions()

setUpdateIntervalMs

public void setUpdateIntervalMs(int updateIntervalMs)

getUpdateIntervalMs

public int getUpdateIntervalMs()

getProcessingKey

public String getProcessingKey()

Specified by:

getProcessingKey in interface IProcessableOption

update

public abstract Coordinate<Number,Number> update()

This method is called for each update interval. It must return a coordinate which is then added to the series on the fly.

May return null. In that case, the chart is simply not updated.

Returns:

the new Coordinate to add to the series.