org.fujion.highcharts

Class Series

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.Series

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class Series
extends Options

A chart series.

Field Summary

Fields

Modifier and Type	Field and Description
List<DataPoint>	data A list of data points.
Integer	index The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
Integer	legendIndex The sequential index of the series in the legend.
String	name The name of the series as shown in the legend, tooltip etc.
PlotOptions	plotOptions Additional options.
Object	stack This option allows grouping series in a stacked chart.
PlotType	type The type of series.
Integer	xAxis When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
Integer	yAxis When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Series(PlotType type)

Method Summary

Modifier and Type	Method and Description
DataPoint	addDataPoint(double y) Adds a single data point.
DataPoint	addDataPoint(double x, double y) Adds a single data point.
void	addDataPoints(double... yvalues) Adds a list of y values.
void	addDataPoints(List<DataPoint> values) Adds a list of data point values.
void	clear() Clear all data points.
OptionMap	toMap() Override to merge plot options into series options.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

data

@Option
public final List<DataPoint> data

A list of data points. Range series values are given by low and high. Example:

 data: [{
     name: 'Point 1',
     color: '#00FF00',
     y: 0
 }, {
     name: 'Point 2',
     color: '#FF00FF',
     y: 5
 }]
 

index

@Option
public Integer index

The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend. Defaults to undefined.

legendIndex

@Option
public Integer legendIndex

The sequential index of the series in the legend.

name

@Option
public String name

The name of the series as shown in the legend, tooltip etc. Defaults to "".

stack

@Option
public Object stack

This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other. Defaults to null.

type

@Option
public final PlotType type

The type of series. Defaults to "line".

xAxis

@Option
public Integer xAxis

When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.

yAxis

@Option
public Integer yAxis

When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.

plotOptions

@Option(ignore=true)
public final PlotOptions plotOptions

Additional options.

Constructor Detail

Series

protected Series(PlotType type)

Method Detail

addDataPoint

public DataPoint addDataPoint(double y)

Adds a single data point.

Parameters:

y - Y value

Returns:

The newly added data point.

addDataPoint

public DataPoint addDataPoint(double x,
                              double y)

Adds a single data point.

Parameters:

x - X value

y - Y value

Returns:

The newly added data point.

addDataPoints

public void addDataPoints(List<DataPoint> values)

Adds a list of data point values.

Parameters:

values - Data points to add.

addDataPoints

public void addDataPoints(double... yvalues)

Adds a list of y values.

Parameters:

yvalues - Y values to add.

clear

public void clear()

Clear all data points.

toMap

public OptionMap toMap()

Override to merge plot options into series options.

Specified by:

toMap in interface OptionMap.IOptionMapConverter

Overrides:

toMap in class Options