net.java.html.charts

Class Chart<D,C extends Config>

java.lang.Object

net.java.html.charts.Chart<D,C>

Type Parameters:

D - type of data to put into getData() list

C - type of the configuration object for this chart

public final class Chart<D,C extends Config>
extends Object

Instance of a single chart. The chart is created by one of the factory methods (like createBar(net.java.html.charts.Values.Set...), createLine(net.java.html.charts.Values.Set...), createPie(), etc.) methods and should first be filled with data:

 chart.getData().add(....);
 

and then displayed on the HTML page by attaching it to an existing DOM element identified by an ID:

 chart.applyTo("elementId");
 

Method Summary

Modifier and Type	Method and Description
void	addChartListener(ChartListener l) Adds a listener to the chart.
void	applyTo(String id) Associates the chart with an element on the page.
static Chart<Values,Config>	createBar(Values.Set... dataSets) Creates new bar chart.
static Chart<Segment,Config>	createDoughnut() Creates new doughnut (e.g.
static Chart<Values,Config>	createLine(Values.Set... dataSets) Creates new line based chart.
static Chart<Segment,Config>	createPie() Creates new pie chart.
static Chart<Segment,Config>	createPolar() Creates new radar (e.g.
static Chart<Values,Config>	createRadar(Values.Set... dataSets) Creates new radar chart.
void	destroy() Destroy the graph and cleanup associated resources.
C	getConfig() Access to configuration associated with this graph.
List<D>	getData() The data displayed by this graph.
void	removeChartListener(ChartListener l) Removes a listener from the chart.

Methods inherited from class java.lang.Object

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

Method Detail

applyTo

public void applyTo(String id)

Associates the chart with an element on the page. This method can be called just once. If used twice, it throws an exception.

Parameters:

id - the id of the element to place the chart to

Throws:

IllegalStateException - if already applied to some element

addChartListener

public void addChartListener(ChartListener l)

Adds a listener to the chart.

Parameters:

l - the listener

removeChartListener

public void removeChartListener(ChartListener l)

Removes a listener from the chart.

Parameters:

l - the listener

getConfig

public C getConfig()

Access to configuration associated with this graph. The configuration object is either generic Config object, or a specialized one tailored for the features of this chart.

Returns:

non-null configuration object for this chart

getData

public List<D> getData()

The data displayed by this graph. One can change the data, remove some elements, add new ones. The chart will be updated according to such change.

Returns:

modifiable list of data the chart displays

destroy

public void destroy()

Destroy the graph and cleanup associated resources.

createLine

public static Chart<Values,Config> createLine(Values.Set... dataSets)

Creates new line based chart.

Parameters:

dataSets - individual sets of values to display

Returns:

chart object to be filled with data and displayed.

createRadar

public static Chart<Values,Config> createRadar(Values.Set... dataSets)

Creates new radar chart.

Parameters:

dataSets - individual sets of values to display

Returns:

chart object to be filled with data and displayed.

createBar

public static Chart<Values,Config> createBar(Values.Set... dataSets)

Creates new bar chart.

Parameters:

dataSets - individual sets of values to display

Returns:

chart object to be filled with data and displayed.

createPie

public static Chart<Segment,Config> createPie()

Creates new pie chart.

Returns:

chart object to be filled with data and displayed.

createDoughnut

public static Chart<Segment,Config> createDoughnut()

Creates new doughnut (e.g. pie with missing center) chart.

Returns:

chart object to be filled with data and displayed.

createPolar

public static Chart<Segment,Config> createPolar()

Creates new radar (e.g. scaled pie) chart.

Returns:

chart object to be filled with data and displayed.