org.pepstock.charba.client

Class AbstractChart<O extends BaseOptions,D extends Dataset>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

org.pepstock.charba.client.AbstractChart<O,D>

Type Parameters:

O - Options type for the specific chart

D - Dataset type for the specific chart

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, IsChart<O,D>

Direct Known Subclasses:

BarChart, BubbleChart, DoughnutChart, GaugeChart, LineChart, MeterChart, PieChart, PolarAreaChart, RadarChart, ScatterChart, StackedAreaChart, StackedBarChart

public abstract class AbstractChart<O extends BaseOptions,D extends Dataset>
extends com.google.gwt.user.client.ui.Widget
implements IsChart<O,D>

Base class of all charts.
It contains Chart.js initialization.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractChart() Initializes HTMl elements (DIV and Canvas). It sets also some default behaviors (width in percentage) for resizing

Method Summary

Modifier and Type	Method and Description
void	clear() Will clear the chart canvas.
protected com.google.gwt.event.shared.HandlerManager	createHandlerManager()
void	destroy() Use this to destroy any chart instances that are created.
void	draw()
java.lang.String	generateLegend() Returns an HTML string of a legend for that chart.
com.google.gwt.dom.client.CanvasElement	getCanvas()
ChartNode	getChartNode() Returns the chart node with runtime data.
com.google.gwt.dom.client.DivElement	getContainer()
Data	getData()
DatasetMetaItem	getDatasetMeta(int index) Looks for the dataset that matches the current index and returns that metadata.
DatasetItem	getElementAtEvent(ChartNativeEvent event) Calling on your chart instance passing an argument of an event, will return the single element at the event position. If there are multiple items within range, only the first is returned.
DatasetMetaItem	getElementsAtEvent(ChartNativeEvent event) Looks for the element under the event point, then returns all elements at the same data index. Calling it on your chart instance passing an argument of an event, will return the point elements that are at that the same position of that event.
GlobalOptions	getGlobal()
java.lang.String	getId() Returns the ID of chart. It could be considered as chart unique ID.
Plugins	getPlugins()
boolean	isDestroyOnDetach()
boolean	isDrawOnAttach()
protected void	onAttach()
protected void	onDetach()
void	render() Triggers a redraw of all chart elements.
void	render(UpdateConfiguration config) Triggers a redraw of all chart elements.
void	reset() Reset the chart to it's state before the initial animation.
void	resize() Use this to manually resize the canvas element.
void	setDestroyOnDetach(boolean destroyOnDetach)
void	setDrawOnAttach(boolean drawOnAttach)
void	setHeight(java.lang.String height)
void	setWidth(java.lang.String width)
void	stop() Use this to stop any current animation loop.
java.lang.String	toBase64Image() his returns a base 64 encoded string of the chart in it's current state.
java.lang.String	toJSONString() Returns the chart configuration in JSON format.
void	update() Triggers an update of the chart.
void	update(UpdateConfiguration config) Triggers an update of the chart.

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.IsChart

getOptions, getType, newDataset

Constructor Detail

AbstractChart

public AbstractChart()

Initializes HTMl elements (DIV and Canvas).
It sets also some default behaviors (width in percentage) for resizing

Method Detail

createHandlerManager

protected com.google.gwt.event.shared.HandlerManager createHandlerManager()

Overrides:

createHandlerManager in class com.google.gwt.user.client.ui.Widget

getId

public final java.lang.String getId()

Returns the ID of chart.
It could be considered as chart unique ID.

Returns:

the ID of chart

getCanvas

public final com.google.gwt.dom.client.CanvasElement getCanvas()

Returns:

the canvas

getContainer

public final com.google.gwt.dom.client.DivElement getContainer()

Returns:

the chart container HTML element

getChartNode

public final ChartNode getChartNode()

Returns the chart node with runtime data.

Returns:

the chart node.

getData

public final Data getData()

Returns:

the data configuration object

getPlugins

public final Plugins getPlugins()

Returns:

the plugins configuration object

getGlobal

public GlobalOptions getGlobal()

Returns:

the options

setHeight

public void setHeight(java.lang.String height)

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

setWidth

public void setWidth(java.lang.String width)

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

isDrawOnAttach

public boolean isDrawOnAttach()

Returns:

the drawOnAttach

setDrawOnAttach

public void setDrawOnAttach(boolean drawOnAttach)

Parameters:

drawOnAttach - the drawOnAttach to set

isDestroyOnDetach

public boolean isDestroyOnDetach()

Returns:

the destroyOnDetach

setDestroyOnDetach

public void setDestroyOnDetach(boolean destroyOnDetach)

Parameters:

destroyOnDetach - the destroyOnDetach to set

onAttach

protected void onAttach()

Overrides:

onAttach in class com.google.gwt.user.client.ui.Widget

onDetach

protected void onDetach()

Overrides:

onDetach in class com.google.gwt.user.client.ui.Widget

destroy

public void destroy()

Use this to destroy any chart instances that are created. This will clean up any references stored to the chart object within Chart.js, along with any associated event listeners attached by Chart.js.

stop

public void stop()

Use this to stop any current animation loop. This will pause the chart during any current animation frame. Call .render() to re-animate.

See Also:

render()

clear

public void clear()

Will clear the chart canvas. Used extensively internally between animation frames.

reset

public void reset()

Reset the chart to it's state before the initial animation. A new animation can then be triggered using update.

toBase64Image

public java.lang.String toBase64Image()

his returns a base 64 encoded string of the chart in it's current state.

Returns:

base 64 image or null if chart is not initialized

generateLegend

public java.lang.String generateLegend()

Returns an HTML string of a legend for that chart. The legend is generated from the legendCallback in the options.

Returns:

the HTML legend or null if chart is not initialized

See Also:

LegendCallback

resize

public void resize()

Use this to manually resize the canvas element. This is run each time the canvas container is resized, but can be called this method manually if you change the size of the canvas nodes container element.

update

public void update()

Triggers an update of the chart. This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart.

update

public void update(UpdateConfiguration config)

Triggers an update of the chart. This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart. A config object can be provided with additional configuration for the update process. This is useful when update is manually called inside an event handler and some different animation is desired.

Parameters:

config - A config object can be provided with additional configuration for the update process

See Also:

UpdateConfiguration

render

public void render()

Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use .update() in that case.

See Also:

update()

render

public void render(UpdateConfiguration config)

Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use .update() in that case. A config object can be provided with additional configuration for the render process. This is useful when update is manually called inside an event handler and some different animation is desired.

Parameters:

config - A config object can be provided with additional configuration for the render process

See Also:

update(), UpdateConfiguration

getDatasetMeta

public DatasetMetaItem getDatasetMeta(int index)

Looks for the dataset that matches the current index and returns that metadata.

Parameters:

index - dataset index

Returns:

dataset meta data item.

getElementAtEvent

public DatasetItem getElementAtEvent(ChartNativeEvent event)

Calling on your chart instance passing an argument of an event, will return the single element at the event position.
If there are multiple items within range, only the first is returned.

Parameters:

event - event of chart.

Returns:

single element at the event position or null.

getElementsAtEvent

public DatasetMetaItem getElementsAtEvent(ChartNativeEvent event)

Looks for the element under the event point, then returns all elements at the same data index.
Calling it on your chart instance passing an argument of an event, will return the point elements that are at that the same position of that event.

Parameters:

event - event of chart.

Returns:

all elements at the same data index or an empty list.

draw

public void draw()

toJSONString

public java.lang.String toJSONString()

Returns the chart configuration in JSON format.

Returns:

the chart configuration in JSON format.