AbstractChartWidget (Charba - J2CL and GWT charts library based on 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.gwt.widgets.AbstractChartWidget<C>

Type Parameters:

C - type for the specific chart

All Implemented Interfaces:

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

Direct Known Subclasses:

BarChartWidget, BubbleChartWidget, DoughnutChartWidget, GaugeChartWidget, HorizontalBarChartWidget, LineChartWidget, MeterChartWidget, PieChartWidget, PolarAreaChartWidget, RadarChartWidget, ScatterChartWidget, StackedAreaChartWidget, StackedBarChartWidget, TimeSeriesBarChartWidget, TimeSeriesLineChartWidget
```
public abstract class AbstractChartWidget<C extends IsChart>
extends SimplePanel
implements IsChart
```
Base class of all GWT WIDGET charts.

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
Modifier Constructor and Description

protected AbstractChartWidget(C chart)
Creates a chart widget for GWT by chart element instance.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractChartWidget(C chart)` Creates a chart widget for GWT by chart element instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addHandler(EventHandler handler, EventType type)` Adds this handler to the widget.
`void`	`destroy()` Use this to destroy any chart instances that are created.
`void`	`draw()` Draws the chart
`void`	`fireEvent(Event event)` Fires the event to the handlers.
`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.
`C`	`getChart()` Returns the chart instance, wrapped by this GWT widget.
`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.
`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.
`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`.
`void`	`reconfigure()` Triggers an update of the chart.
`void`	`reconfigure(UpdateConfiguration config)` 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. Note, this does not update elements for new data.
`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)` 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.
`void`	`update()` Triggers an update of the chart.
`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.

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, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, 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
checkAndGetIfConsistent, checkIfConsistent, checkIfValid, clear, getOptions, isAbstractChart, isConsistent, isValid

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

- Constructor Detail
  - AbstractChartWidget
```
protected AbstractChartWidget(C chart)
```
    Creates a chart widget for GWT by chart element instance.
    
    Parameters:
    
    chart - chart instance to wrap by the widget
- Method Detail
  - getChart
```
public final C getChart()
```
    Returns the chart instance, wrapped by this GWT widget.
    
    Returns:
    
    the chart instance, wrapped by this GWT widget
  - fireEvent
```
public final void fireEvent(Event event)
```
    Description copied from interface: IsChart
    
    Fires the event to the handlers.
    
    Specified by:
    
    fireEvent in interface IsChart
    
    Parameters:
    
    event - the event to fire
  - addHandler
```
public final HandlerRegistration addHandler(EventHandler handler,
                                            EventType type)
```
    Description copied from interface: IsChart
    
    Adds this handler to the widget.
    
    Specified by:
    
    addHandler in interface IsChart
    
    Parameters:
    
    handler - the handler
    
    type - the event type
    
    Returns:
    
    handler registration used to remove the handler
  - 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.
  - 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.
  - getId
```
public final String getId()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    Returns the canvas element used to draw the chart.
    
    Specified by:
    
    getCanvas in interface IsChart
    
    Returns:
    
    the canvas
  - removeCanvasPreventDefault
```
public final void removeCanvasPreventDefault()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    Returns the chart node with runtime data.
    
    Specified by:
    
    getNode in interface IsChart
    
    Returns:
    
    the chart node.
  - getData
```
public final Data getData()
```
    Description copied from interface: IsChart
    
    Returns the data object with all passed datasets.
    
    Specified by:
    
    getData in interface IsChart
    
    Returns:
    
    the data configuration object
  - getPlugins
```
public final Plugins getPlugins()
```
    Description copied from interface: IsChart
    
    Returns the plugins element to manage inline plugins.
    
    Specified by:
    
    getPlugins in interface IsChart
    
    Returns:
    
    the plugins configuration object
  - getDefaultChartOptions
```
public final IsDefaultScaledOptions getDefaultChartOptions()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    Returns the default options by a chart instance, merging global, chart type global and chart options.
    
    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()
```
    Description copied from interface: IsChart
    
    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)
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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)
```
    Description copied from interface: IsChart
    
    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
  - destroy
```
public final void destroy()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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
  - reset
```
public final void reset()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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 config)
```
    Description copied from interface: IsChart
    
    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.
    
    Specified by:
    
    update in interface IsChart
    
    Parameters:
    
    config - a config object can be provided with additional configuration for the update process
  - reconfigure
```
public final void reconfigure()
```
    Description copied from interface: IsChart
    
    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 config)
```
    Description copied from interface: IsChart
    
    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:
    
    config - a configuration object can be provided with additional configuration for the update process
  - render
```
public final void render()
```
    Description copied from interface: IsChart
    
    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 config)
```
    Description copied from interface: IsChart
    
    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.
    
    Specified by:
    
    render in interface IsChart
    
    Parameters:
    
    config - a config object can be provided with additional configuration for the render process
  - getDatasetMeta
```
public final DatasetMetaItem getDatasetMeta(int index)
```
    Description copied from interface: IsChart
    
    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.
  - getDatasetAtEvent
```
public final DatasetMetaItem getDatasetAtEvent(BaseNativeEvent event)
```
    Description copied from interface: IsChart
    
    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.
  - isDatasetVisible
```
public final boolean isDatasetVisible(int index)
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    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)
```
    Description copied from interface: IsChart
    
    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.
  - getElementsAtEvent
```
public final List<DatasetItem> getElementsAtEvent(BaseNativeEvent event)
```
    Description copied from interface: IsChart
    
    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()
```
    Description copied from interface: IsChart
    
    Draws the chart
    
    Specified by:
    
    draw in interface IsChart

Class AbstractChartWidget<C extends IsChart>

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 java.lang.Iterable

Constructor Detail

AbstractChartWidget

Method Detail

getChart

fireEvent

addHandler

getChartElement

getType

getBaseType

getId

getCanvas

removeCanvasPreventDefault

getInitialCursor

isInitialized

getNode

getData

getPlugins

getDefaultChartOptions

getWholeOptions

isDrawOnAttach

setDrawOnAttach

isDestroyOnDetach

setDestroyOnDetach

destroy

stop

reset

toBase64Image

generateLegend

resize

update

update

reconfigure

reconfigure

render

render

getDatasetMeta

getDatasetAtEvent

isDatasetVisible

getVisibleDatasetCount

getElementAtEvent

getElementsAtEvent

draw