AbstractChart (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.google.gwt.user.client.ui.Panel
    - - com.google.gwt.user.client.ui.SimplePanel
      - org.pepstock.charba.client.AbstractChart<D>

Type Parameters:

D - Dataset type for the specific chart

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, AcceptsOneWidget, HasOneWidget, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IsWidget, Iterable<Widget>, IsChart

Direct Known Subclasses:

BarChart, BubbleChart, DoughnutChart, GaugeChart, LineChart, MeterChart, PieChart, PolarAreaChart, RadarChart, ScatterChart, StackedAreaChart, StackedBarChart, TimeSeriesBarChart, TimeSeriesLineChart
```
public abstract class AbstractChart<D extends Dataset>
extends SimplePanel
implements IsChart
```
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
  UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
- Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
  HasWidgets.ForIsWidget

Field Summary
- Fields inherited from class com.google.gwt.user.client.ui.UIObject
  DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AbstractChart()` Initializes simple panel and canvas which are used by CHART.JS. It sets also some default behaviors (width in percentage) for resizing

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Will clear the chart canvas.
`protected ChartOptions`	`createChartOptions()` Creates the chart options based on type of chart. It can be override when a controller is implemented.
`protected HandlerManager`	`createHandlerManager()`
`void`	`destroy()` Use this to destroy any chart instances that are created.
`void`	`draw()` Draws the chart
`String`	`generateLegend()` Returns an HTML string of a legend for that chart.
`Canvas`	`getCanvas()` Returns the canvas element used to draw the chart.
`Data`	`getData()` Returns the data object with all passed datasets.
`DatasetMetaItem`	`getDatasetAtEvent(ChartNativeEvent event)` Looks for the dataset that matches the event and returns that metadata.
`DatasetMetaItem`	`getDatasetMeta(int index)` Looks for the dataset that matches the current index and returns that metadata.
`ChartOptions`	`getDefaultChartOptions()` Returns the default options created based on chart type.
`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.
`List<DatasetItem>`	`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.
`String`	`getId()` Returns the ID of chart. It could be considered as chart unique ID.
`Style.Cursor`	`getInitialCursor()` Returns the initial cursor of the chart.
`ChartNode`	`getNode()` Returns the chart node with runtime data.
`Plugins`	`getPlugins()` Returns the plugins element to manage inline plugins.
`int`	`getVisibleDatasetCount()` Returns the amount of datasets which are visible
`boolean`	`isDatasetVisible(int index)` Looks for the dataset if it's visible or not, selected by index.
`boolean`	`isDestroyOnDetach()` Returns `true` if the chart is configured to be destroyed on the attach of DIV element, otherwise `false`.
`boolean`	`isDrawOnAttach()` Returns `true` if the chart is configured to be drawn on the attach of DIV element, otherwise `false`.
`boolean`	`isInitialized()` Returns `true` if CHART.JS chart has been initialized, otherwise `false`.
`abstract D`	`newDataset()` Creates a new dataset related to chart type.
`protected void`	`onAttach()`
`protected void`	`onDetach()`
`void`	`removeCanvasPreventDefault()` Remove the registration of prevent default mouse listener from canvas. This is necessary when you will add your mouse down listener.
`void`	`render()` Triggers a redraw of all chart elements.
`void`	`render(UpdateConfiguration configuration)` 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)` Sets `true` if the chart is configured to be destroyed on the attach of DIV element, otherwise `false`.
`void`	`setDrawOnAttach(boolean drawOnAttach)` Sets `true` if the chart is configured to be draw on the attach of DIV element, otherwise `false`.
`void`	`stop()` Use this to stop any current animation loop.
`String`	`toBase64Image()` Returns a base 64 encoded string of the chart in it's current state.
`String`	`toJSON()` Returns the string JSON representation of the object.
`void`	`update()` Triggers an update of the chart.
`void`	`update(UpdateConfiguration configuration)` Triggers an update of the chart.
`void`	`updateOptions()` Triggers an update of the chart.
`void`	`updateOptions(UpdateConfiguration configuration)` Triggers an update of the chart.

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel
add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel
add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, delegateEvent, 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, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, 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
addHandler, getOptions, getType

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - AbstractChart
```
public AbstractChart()
```
    Initializes simple panel and canvas which are used by CHART.JS.
    It sets also some default behaviors (width in percentage) for resizing
- Method Detail
  - createHandlerManager
```
protected final HandlerManager createHandlerManager()
```
    Overrides:
    
    createHandlerManager in class Widget
  - newDataset
```
public abstract D newDataset()
```
    Creates a new dataset related to chart type.
    
    Returns:
    
    a new dataset related to chart type.
  - getId
```
public final String getId()
```
    Returns the ID of chart.
    It could be considered as chart unique ID.
    
    Specified by:
    
    getId in interface IsChart
    
    Returns:
    
    the ID of chart
  - getCanvas
```
public final Canvas getCanvas()
```
    Returns the canvas element used to draw the chart.
    
    Specified by:
    
    getCanvas in interface IsChart
    
    Returns:
    
    the canvas
  - removeCanvasPreventDefault
```
public final void removeCanvasPreventDefault()
```
    Remove the registration of prevent default mouse listener from canvas.
    This is necessary when you will add your mouse down listener.
    
    Specified by:
    
    removeCanvasPreventDefault in interface IsChart
  - getInitialCursor
```
public final Style.Cursor getInitialCursor()
```
    Returns the initial cursor of the chart.
    
    Specified by:
    
    getInitialCursor in interface IsChart
    
    Returns:
    
    the initial cursor of the chart.
  - isInitialized
```
public final boolean isInitialized()
```
    Returns true if CHART.JS chart has been initialized, otherwise false.
    
    Specified by:
    
    isInitialized in interface IsChart
    
    Returns:
    
    true if CHART.JS chart has been initialized, otherwise false.
  - getNode
```
public final ChartNode getNode()
```
    Returns the chart node with runtime data.
    
    Specified by:
    
    getNode in interface IsChart
    
    Returns:
    
    the chart node.
  - getData
```
public final Data getData()
```
    Returns the data object with all passed datasets.
    
    Specified by:
    
    getData in interface IsChart
    
    Returns:
    
    the data configuration object
  - getPlugins
```
public final Plugins getPlugins()
```
    Returns the plugins element to manage inline plugins.
    
    Specified by:
    
    getPlugins in interface IsChart
    
    Returns:
    
    the plugins configuration object
  - createChartOptions
```
protected ChartOptions createChartOptions()
```
    Creates the chart options based on type of chart.
    It can be override when a controller is implemented.
    
    Returns:
    
    the chart options based on type of chart.
  - getDefaultChartOptions
```
public final ChartOptions getDefaultChartOptions()
```
    Returns the default options created based on chart type.
    
    Specified by:
    
    getDefaultChartOptions in interface IsChart
    
    Returns:
    
    the default options of the chart
  - isDrawOnAttach
```
public final boolean isDrawOnAttach()
```
    Returns true if the chart is configured to be drawn on the attach of DIV element, otherwise false.
    
    Specified by:
    
    isDrawOnAttach in interface IsChart
    
    Returns:
    
    the drawOnAttach true if the chart is configured to be drawn on the attach of DIV element, otherwise false. Default is true.
  - setDrawOnAttach
```
public final void setDrawOnAttach(boolean drawOnAttach)
```
    Sets true if the chart is configured to be draw on the attach of DIV element, otherwise false.
    
    Specified by:
    
    setDrawOnAttach in interface IsChart
    
    Parameters:
    
    drawOnAttach - the drawOnAttach to set
  - isDestroyOnDetach
```
public final boolean isDestroyOnDetach()
```
    Returns true if the chart is configured to be destroyed on the attach of DIV element, otherwise false.
    
    Specified by:
    
    isDestroyOnDetach in interface IsChart
    
    Returns:
    
    the destroyOnDetach true if the chart is configured to be destroyed on the attach of DIV element, otherwise false. Default is true.
  - setDestroyOnDetach
```
public final void setDestroyOnDetach(boolean destroyOnDetach)
```
    Sets true if the chart is configured to be destroyed on the attach of DIV element, otherwise false.
    
    Specified by:
    
    setDestroyOnDetach in interface IsChart
    
    Parameters:
    
    destroyOnDetach - the destroyOnDetach to set
  - onAttach
```
protected void onAttach()
```
    Overrides:
    
    onAttach in class Widget
  - onDetach
```
protected void onDetach()
```
    Overrides:
    
    onDetach in class Widget
  - destroy
```
public final 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.
    
    Specified by:
    
    destroy in interface IsChart
  - stop
```
public final 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.
    
    Specified by:
    
    stop in interface IsChart
  - clear
```
public final void clear()
```
    Will clear the chart canvas. Used extensively internally between animation frames.
    Overrides the clear method of GWT Panel, changing completely the behavior of GWT Panel one.
    
    Specified by:
    
    clear in interface HasWidgets
    
    Specified by:
    
    clear in interface IsChart
    
    Overrides:
    
    clear in class Panel
  - reset
```
public final void reset()
```
    Reset the chart to it's state before the initial animation. A new animation can then be triggered using update.
    
    Specified by:
    
    reset in interface IsChart
  - toBase64Image
```
public final String toBase64Image()
```
    Returns a base 64 encoded string of the chart in it's current state.
    
    Specified by:
    
    toBase64Image in interface IsChart
    
    Returns:
    
    base 64 image or UndefinedValues.STRING if chart is not initialized.
  - generateLegend
```
public final String generateLegend()
```
    Returns an HTML string of a legend for that chart. The legend is generated from the legendCallback in the options.
    
    Specified by:
    
    generateLegend in interface IsChart
    
    Returns:
    
    the HTML legend or UndefinedValues.STRING if chart is not initialized.
  - resize
```
public final 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.
    
    Specified by:
    
    resize in interface IsChart
  - update
```
public final 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.
    
    Specified by:
    
    update in interface IsChart
  - update
```
public final void update(UpdateConfiguration configuration)
```
    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 configuration 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.
    
    Specified by:
    
    update in interface IsChart
    
    Parameters:
    
    configuration - a configuration object can be provided with additional configuration for the update process
  - updateOptions
```
public final void updateOptions()
```
    Triggers an update of the chart. This can be safely called after updating the data object. This will update the options, mutating the options property in place.
    
    Specified by:
    
    updateOptions in interface IsChart
  - updateOptions
```
public final void updateOptions(UpdateConfiguration configuration)
```
    Triggers an update of the chart. This can be safely called after updating the data object. This will update the options, mutating the options property in place. A configuration 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.
    
    Specified by:
    
    updateOptions in interface IsChart
    
    Parameters:
    
    configuration - a configuration object can be provided with additional configuration for the update process
  - render
```
public final void render()
```
    Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use .update() in that case.
    
    Specified by:
    
    render in interface IsChart
  - render
```
public final void render(UpdateConfiguration configuration)
```
    Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use .update() in that case. A configuration 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.
    
    Specified by:
    
    render in interface IsChart
    
    Parameters:
    
    configuration - a configuration object can be provided with additional configuration for the render process
  - getDatasetMeta
```
public final DatasetMetaItem getDatasetMeta(int index)
```
    Looks for the dataset that matches the current index and returns that metadata.
    
    Specified by:
    
    getDatasetMeta in interface IsChart
    
    Parameters:
    
    index - dataset index
    
    Returns:
    
    dataset meta data item or null if the index is out of range of datasets count.
  - getDatasetAtEvent
```
public DatasetMetaItem getDatasetAtEvent(ChartNativeEvent event)
```
    Looks for the dataset that matches the event and returns that metadata.
    
    Specified by:
    
    getDatasetAtEvent in interface IsChart
    
    Parameters:
    
    event - event of chart.
    
    Returns:
    
    dataset meta data item or null if event is not consistent
  - isDatasetVisible
```
public boolean isDatasetVisible(int index)
```
    Looks for the dataset if it's visible or not, selected by index.
    
    Specified by:
    
    isDatasetVisible in interface IsChart
    
    Parameters:
    
    index - dataset index
    
    Returns:
    
    true if dataset is visible otherwise false.
  - getVisibleDatasetCount
```
public int getVisibleDatasetCount()
```
    Returns the amount of datasets which are visible
    
    Specified by:
    
    getVisibleDatasetCount in interface IsChart
    
    Returns:
    
    the amount of datasets which are visible. If chart is not initialized, return UndefinedValues.INTEGER.
  - getElementAtEvent
```
public final 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.
    
    Specified by:
    
    getElementAtEvent in interface IsChart
    
    Parameters:
    
    event - event of chart.
    
    Returns:
    
    single element at the event position or null if event is not consistent
  - getElementsAtEvent
```
public final List<DatasetItem> 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.
    
    Specified by:
    
    getElementsAtEvent in interface IsChart
    
    Parameters:
    
    event - event of chart.
    
    Returns:
    
    all elements at the same data index or an empty list.
  - draw
```
public final void draw()
```
    Draws the chart
    
    Specified by:
    
    draw in interface IsChart
  - toJSON
```
public final String toJSON()
```
    Returns the string JSON representation of the object.
    
    Specified by:
    
    toJSON in interface IsChart
    
    Returns:
    
    the string JSON representation of the object.

Class AbstractChart<D extends Dataset>

Nested Class Summary

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractChart

Method Detail

createHandlerManager

newDataset

getId

getCanvas

removeCanvasPreventDefault

getInitialCursor

isInitialized

getNode

getData

getPlugins

createChartOptions

getDefaultChartOptions

isDrawOnAttach

setDrawOnAttach

isDestroyOnDetach

setDestroyOnDetach

onAttach

onDetach

destroy

stop

clear

reset

toBase64Image

generateLegend

resize

update

update

updateOptions

updateOptions

render

render

getDatasetMeta

getDatasetAtEvent

isDatasetVisible

getVisibleDatasetCount

getElementAtEvent

getElementsAtEvent

draw

toJSON