IsChart (Charba - GWT Charts library based on CHART.JS)

All Superinterfaces:

HasHandlers

All Known Implementing Classes:

AbstractChart, BarChart, BubbleChart, DoughnutChart, GaugeChart, HorizontalBarChart, LineChart, MeterChart, PieChart, PolarAreaChart, RadarChart, ScatterChart, StackedAreaChart, StackedBarChart, TimeSeriesBarChart, TimeSeriesLineChart
```
public interface IsChart
extends HasHandlers
```
Interface which defines a chart.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`<H extends EventHandler> HandlerRegistration`	`addHandler(H handler, GwtEvent.Type<H> type)` Adds this handler to the widget.
`static void`	`checkIfConsistent(IsChart chart)` Check if chart passed as argument is not `null` and its id is not `null` as well, and if mandatory methods of interface will return consistent instances. If not, throw a `IllegalArgumentException`.
`static void`	`checkIfValid(IsChart chart)` Checks if chart passed as argument is not `null` and its id is not `null` as well. If not, throw a `IllegalArgumentException`.
`void`	`clear()` Will clear the chart canvas.
`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 `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.
`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.
`IsDefaultScaledOptions`	`getDefaultChartOptions()` Returns the default options created based on chart type.
`Element`	`getElement()` Gets a handle to the object's underlying DOM element.
`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.
`ConfigurationOptions`	`getOptions()` Returns the options of chart.
`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.
`static boolean`	`isAbstractChart(IsChart chart)` Returns `true` if chart passed as argument is an abstract chart instance.
`static boolean`	`isConsistent(IsChart chart)` Returns `true` if chart passed as argument is not `null` and its id is not `null` as well, and if mandatory methods of interface will return consistent instances.
`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`.
`static boolean`	`isValid(IsChart chart)` Returns `true` if chart passed as argument is not `null` and its id is not `null` as well.
`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. 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.
`String`	`toJSON()` Returns the string JSON representation of the object.
`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 interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Method Detail
  - isConsistent
```
static boolean isConsistent(IsChart chart)
```
    Returns true if chart passed as argument is not null and its id is not null as well, and if mandatory methods of interface will return consistent instances.
    
    Parameters:
    
    chart - chart to be checked
    
    Returns:
    
    true if chart passed as argument is not null and its id is not null as well, and if mandatory methods of interface will return consistent instances.
  - checkIfConsistent
```
static void checkIfConsistent(IsChart chart)
```
    Check if chart passed as argument is not null and its id is not null as well, and if mandatory methods of interface will return consistent instances.
    If not, throw a IllegalArgumentException.
    
    Parameters:
    
    chart - chart to be checked
  - isValid
```
static boolean isValid(IsChart chart)
```
    Returns true if chart passed as argument is not null and its id is not null as well.
    
    Parameters:
    
    chart - chart to be checked
    
    Returns:
    
    true if chart passed as argument is not null and its id is not null as well
  - checkIfValid
```
static void checkIfValid(IsChart chart)
```
    Checks if chart passed as argument is not null and its id is not null as well.
    If not, throw a IllegalArgumentException.
    
    Parameters:
    
    chart - chart to be checked
  - isAbstractChart
```
static boolean isAbstractChart(IsChart chart)
```
    Returns true if chart passed as argument is an abstract chart instance.
    
    Parameters:
    
    chart - chart to be checked
    
    Returns:
    
    true if chart passed as argument is an abstract chart instance
  - addHandler
```
<H extends EventHandler> HandlerRegistration addHandler(H handler,
                                                        GwtEvent.Type<H> type)
```
    Adds this handler to the widget.
    
    Type Parameters:
    
    H - the type of handler to add
    
    Parameters:
    
    type - the event type
    
    handler - the handler
    
    Returns:
    
    HandlerRegistration used to remove the handler
  - getElement
```
Element getElement()
```
    Gets a handle to the object's underlying DOM element.
    
    Returns:
    
    the object's browser element
  - getOptions
```
ConfigurationOptions getOptions()
```
    Returns the options of chart.
    
    Returns:
    
    the options of chart.
  - getType
```
Type getType()
```
    Returns the type of chart.
    
    Returns:
    
    the type of chart.
  - getBaseType
```
Type getBaseType()
```
    Returns the base type of chart that in case of ChartType is the same of getType() otherwise, in case the type of the chart is a ControllerType is the chart type extension if there is or null.
    
    Returns:
    
    the base type of chart.
  - getId
```
String getId()
```
    Returns the ID of chart.
    It could be considered as chart unique ID.
    
    Returns:
    
    the ID of chart
  - getCanvas
```
Canvas getCanvas()
```
    Returns the canvas element used to draw the chart.
    
    Returns:
    
    the canvas
  - removeCanvasPreventDefault
```
void removeCanvasPreventDefault()
```
    Remove the registration of prevent default mouse listener from canvas.
    This is necessary when you will add your mouse down listener.
  - getInitialCursor
```
Style.Cursor getInitialCursor()
```
    Returns the initial cursor of the chart.
    
    Returns:
    
    the initial cursor of the chart.
  - isInitialized
```
boolean isInitialized()
```
    Returns true if CHART.JS chart has been initialized, otherwise false.
    
    Returns:
    
    true if CHART.JS chart has been initialized, otherwise false.
  - getNode
```
ChartNode getNode()
```
    Returns the chart node with runtime data.
    
    Returns:
    
    the chart node.
  - getData
```
Data getData()
```
    Returns the data object with all passed datasets.
    
    Returns:
    
    the data configuration object
  - getPlugins
```
Plugins getPlugins()
```
    Returns the plugins element to manage inline plugins.
    
    Returns:
    
    the plugins configuration object
  - getDefaultChartOptions
```
IsDefaultScaledOptions getDefaultChartOptions()
```
    Returns the default options created based on chart type.
    
    Returns:
    
    the default options of the chart
  - getWholeOptions
```
IsDefaultScaledOptions getWholeOptions()
```
    Returns the default options by a chart instance, merging global, chart type global and chart options.
    
    Returns:
    
    the default options by a chart instance, merging global, chart type global and chart options
  - isDrawOnAttach
```
boolean isDrawOnAttach()
```
    Returns true if the chart is configured to be drawn on the attach of DIV element, otherwise false.
    
    Returns:
    
    the drawOnAttach true if the chart is configured to be drawn on the attach of DIV element, otherwise false. Default is true.
  - setDrawOnAttach
```
void setDrawOnAttach(boolean drawOnAttach)
```
    Sets true if the chart is configured to be draw on the attach of DIV element, otherwise false.
    
    Parameters:
    
    drawOnAttach - the drawOnAttach to set
  - isDestroyOnDetach
```
boolean isDestroyOnDetach()
```
    Returns true if the chart is configured to be destroyed on the attach of DIV element, otherwise false.
    
    Returns:
    
    the destroyOnDetach true if the chart is configured to be destroyed on the attach of DIV element, otherwise false. Default is true.
  - setDestroyOnDetach
```
void setDestroyOnDetach(boolean destroyOnDetach)
```
    Sets true if the chart is configured to be destroyed on the attach of DIV element, otherwise false.
    
    Parameters:
    
    destroyOnDetach - the destroyOnDetach to set
  - destroy
```
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
```
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.
  - clear
```
void clear()
```
    Will clear the chart canvas. Used extensively internally between animation frames.
  - reset
```
void reset()
```
    Reset the chart to it's state before the initial animation. A new animation can then be triggered using update.
  - toBase64Image
```
String toBase64Image()
```
    Returns a base 64 encoded string of the chart in it's current state.
    
    Returns:
    
    base 64 image or UndefinedValues.STRING if chart is not initialized.
  - generateLegend
```
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 UndefinedValues.STRING if chart is not initialized.
  - resize
```
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
```
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
```
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
  - reconfigure
```
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.
  - reconfigure
```
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.
    
    Parameters:
    
    configuration - a configuration object can be provided with additional configuration for the update process
  - render
```
void render()
```
    Triggers a redraw of all chart elements.
    Note, this does not update elements for new data. Use .update() in that case.
  - render
```
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
  - getDatasetMeta
```
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.
  - getDatasetAtEvent
```
DatasetMetaItem getDatasetAtEvent(ChartNativeEvent event)
```
    Looks for the dataset that matches the event and returns that metadata.
    
    Parameters:
    
    event - event of chart.
    
    Returns:
    
    dataset meta data item.
  - isDatasetVisible
```
boolean isDatasetVisible(int index)
```
    Looks for the dataset if it's visible or not, selected by index.
    
    Parameters:
    
    index - dataset index
    
    Returns:
    
    true if dataset is visible otherwise false.
  - getVisibleDatasetCount
```
int getVisibleDatasetCount()
```
    Returns the amount of datasets which are visible
    
    Returns:
    
    the amount of datasets which are visible. If chart is not initialized, return UndefinedValues.INTEGER.
  - getElementAtEvent
```
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
```
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.
    
    Parameters:
    
    event - event of chart.
    
    Returns:
    
    all elements at the same data index or an empty list.
  - draw
```
void draw()
```
    Draws the chart
  - toJSON
```
String toJSON()
```
    Returns the string JSON representation of the object.
    
    Returns:
    
    the string JSON representation of the object.

Interface IsChart

Method Summary

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

Method Detail

isConsistent

checkIfConsistent

isValid

checkIfValid

isAbstractChart

addHandler

getElement

getOptions

getType

getBaseType

getId

getCanvas

removeCanvasPreventDefault

getInitialCursor

isInitialized

getNode

getData

getPlugins

getDefaultChartOptions

getWholeOptions

isDrawOnAttach

setDrawOnAttach

isDestroyOnDetach

setDestroyOnDetach

destroy

stop

clear

reset

toBase64Image

generateLegend

resize

update

update

reconfigure

reconfigure

render

render

getDatasetMeta

getDatasetAtEvent

isDatasetVisible

getVisibleDatasetCount

getElementAtEvent

getElementsAtEvent

draw

toJSON