AbstractChart (Charba - J2CL and GWT charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.events.HandlerManager
- - org.pepstock.charba.client.AbstractChart<D>

Type Parameters:

D - Dataset type for the specific chart

All Implemented Interfaces:

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 HandlerManager
implements IsChart
```
Base class of all charts.
It contains Chart.js initialization.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Constructor and Description
`AbstractChart(Type type)` 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
`HandlerRegistration`	`addHandler(EventHandler handler, EventType type)` Adds a event handler.
`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.
`protected ChartOptions`	`createChartOptions()` Creates the chart options based on type of chart. It can be override when a controller is implemented.
`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.
`Type`	`getBaseType()` Returns the base type of chart that in case of `ChartType` is the same of `IsChart.getType()` otherwise, in case the type of the chart is a `ControllerType` is the chart type extension if there is or `null`.
`Canvas`	`getCanvas()` Returns the canvas element used to draw the chart.
`Div`	`getChartElement()` Gets a handle to the object's underlying DOM element.
`Data`	`getData()` Returns the data object with all passed datasets.
`DatasetMetaItem`	`getDatasetAtEvent(BaseNativeEvent 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.
`IsDefaultScaledOptions`	`getDefaultChartOptions()` Returns the default options created based on chart type.
`DatasetItem`	`getElementAtEvent(BaseNativeEvent 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(BaseNativeEvent 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.
`CursorType`	`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.
`protected IsChart`	`getSource()` Returns a chart instance as source for all events.
`Type`	`getType()` Returns the type of chart.
`int`	`getVisibleDatasetCount()` Returns the amount of datasets which are visible
`IsDefaultScaledOptions`	`getWholeOptions()` Returns the default options by a chart instance, merging global, chart type global and chart options. If the options is not consistent, it will returns the `getDefaultChartOptions()`.
`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 detach from 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.
`void`	`onAttach(MutationItem item)` Invoked by mutation observer when a chart has been attached into the DOM tree.
`void`	`onDetach(MutationItem item)` Invoked by mutation observer when a chart has been detached from the DOM tree.
`void`	`reconfigure()` Triggers an update of the chart.
`void`	`reconfigure(UpdateConfiguration configuration)` Triggers an update of the chart.
`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 detach from 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. This will pause the chart during any current animation frame. Call `.render()` to re-animate.
`String`	`toBase64Image()` Returns a base 64 encoded string of the chart in it's current state.
`void`	`update()` Triggers an update of the chart.
`void`	`update(UpdateConfiguration configuration)` Triggers an update of the chart.

Methods inherited from class org.pepstock.charba.client.events.HandlerManager
fireEvent, getHandlerCount, isEventHandled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.IsChart
checkAndGetIfConsistent, checkIfConsistent, checkIfValid, fireEvent, getOptions, isAbstractChart, isConsistent, isValid

- Constructor Detail
  - AbstractChart
```
public AbstractChart(Type type)
```
    Initializes simple panel and canvas which are used by CHART.JS.
    It sets also some default behaviors (width in percentage) for resizing
    
    Parameters:
    
    type - the type of chart
- Method Detail
  - getSource
```
protected final IsChart getSource()
```
    Description copied from class: HandlerManager
    
    Returns a chart instance as source for all events.
    
    Specified by:
    
    getSource in class HandlerManager
    
    Returns:
    
    a chart instance as source for all events
  - addHandler
```
public final HandlerRegistration addHandler(EventHandler handler,
                                            EventType type)
```
    Description copied from class: HandlerManager
    
    Adds a event handler.
    
    Specified by:
    
    addHandler in interface IsChart
    
    Overrides:
    
    addHandler in class HandlerManager
    
    Parameters:
    
    handler - handler instance to add
    
    type - the event type associated with handler
    
    Returns:
    
    the handler registration in order to remove the handler later
  - getChartElement
```
public final Div getChartElement()
```
    Description copied from interface: IsChart
    
    Gets a handle to the object's underlying DOM element.
    
    Specified by:
    
    getChartElement in interface IsChart
    
    Returns:
    
    the object's browser element
  - getType
```
public final Type getType()
```
    Description copied from interface: IsChart
    
    Returns the type of chart.
    
    Specified by:
    
    getType in interface IsChart
    
    Returns:
    
    the type of chart.
  - 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
  - getBaseType
```
public final Type getBaseType()
```
    Description copied from interface: IsChart
    
    Returns the base type of chart that in case of ChartType is the same of IsChart.getType() otherwise, in case the type of the chart is a ControllerType is the chart type extension if there is or null.
    
    Specified by:
    
    getBaseType in interface IsChart
    
    Returns:
    
    the base type 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 CursorType 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 IsDefaultScaledOptions getDefaultChartOptions()
```
    Returns the default options created based on chart type.
    
    Specified by:
    
    getDefaultChartOptions in interface IsChart
    
    Returns:
    
    the default options of the chart
  - getWholeOptions
```
public final IsDefaultScaledOptions getWholeOptions()
```
    Returns the default options by a chart instance, merging global, chart type global and chart options.
    If the options is not consistent, it will returns the getDefaultChartOptions().
    
    Specified by:
    
    getWholeOptions in interface IsChart
    
    Returns:
    
    the default options by a chart instance, merging global, chart type global and chart options
  - 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 detach from DIV element, otherwise false.
    
    Specified by:
    
    isDestroyOnDetach in interface IsChart
    
    Returns:
    
    the destroyOnDetach true if the chart is configured to be destroyed on the detach from 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 detach from DIV element, otherwise false.
    
    Specified by:
    
    setDestroyOnDetach in interface IsChart
    
    Parameters:
    
    destroyOnDetach - the destroyOnDetach to set
  - onAttach
```
public final void onAttach(MutationItem item)
```
    Invoked by mutation observer when a chart has been attached into the DOM tree.
    
    Parameters:
    
    item - can not be instantiated out of this package to avoid that anyone (apart the observer) will invoke the method.
  - onDetach
```
public final void onDetach(MutationItem item)
```
    Invoked by mutation observer when a chart has been detached from the DOM tree.
    
    Parameters:
    
    item - can not be instantiated out of this package to avoid that anyone (apart the observer) will invoke the method.
  - 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 IsChart
  - 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
  - reconfigure
```
public final void reconfigure()
```
    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:
    
    reconfigure in interface IsChart
  - reconfigure
```
public final void reconfigure(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:
    
    reconfigure 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 final DatasetMetaItem getDatasetAtEvent(BaseNativeEvent 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 final 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 final 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(BaseNativeEvent 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(BaseNativeEvent 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

Class AbstractChart<D extends Dataset>

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.events.HandlerManager

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChart

Method Detail

getSource

addHandler

getChartElement

getType

newDataset

getId

getBaseType

getCanvas

removeCanvasPreventDefault

getInitialCursor

isInitialized

getNode

getData

getPlugins

createChartOptions

getDefaultChartOptions

getWholeOptions

isDrawOnAttach

setDrawOnAttach

isDestroyOnDetach

setDestroyOnDetach

onAttach

onDetach

destroy

stop

clear

reset

toBase64Image

generateLegend

resize

update

update

reconfigure

reconfigure

render

render

getDatasetMeta

getDatasetAtEvent

isDatasetVisible

getVisibleDatasetCount

getElementAtEvent

getElementsAtEvent

draw