ConfigurationOptions (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.configuration.EventProvider<ExtendedOptions>
- - org.pepstock.charba.client.configuration.ConfigurationOptions

All Implemented Interfaces:

EventHandler, ConfigurationElement, AddHandlerEventHandler, RemoveHandlerEventHandler

Direct Known Subclasses:

AbstractPieOptions, BarOptions, BubbleOptions, LineOptions, ScatterOptions, SingleScaleOptions, StackedOptions
```
public abstract class ConfigurationOptions
extends EventProvider<ExtendedOptions>
implements ConfigurationElement
```
Base object which maps chart configuration.
Charba stores the unique chart ID into CHART.JS chart options using charbaId property key.
Important topics to take care:
Responsive
When it comes to change the chart size based on the window size, a major limitation is that the canvas render size (canvas.width and .height) can not be expressed with relative values, contrary to the display size (canvas.style.width and .height). Furthermore, these sizes are independent from each other and thus the canvas render size does not adjust automatically based on the display size, making the rendering inaccurate.
It provides a few options to enable responsiveness and control the resize behavior of charts by detecting when the canvas display size changes and update the render size accordingly.
Legend
Sometimes you need a very complex legend. In these cases, it makes sense to generate an HTML legend. Charts provide a generateLegend() method on their prototype that returns an HTML string for the legend. To configure how this legend is generated, you can set the legendCallback.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected <H extends EventHandler> void`	`addHandler(GwtEvent.Type<H> type)` Notifies the event provider when a new handler has been added.
`Animation`	`getAnimation()` Returns the animation element.
`double`	`getAspectRatio()` Canvas aspect ratio (i.e.
`AbstractChart<?,?>`	`getChart()` Returns the chart instance
`protected T`	`getConfiguration()` Returns the configuration element.
`double`	`getDevicePixelRatio()` The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g.
`Elements`	`getElements()` Returns the elements element.
`List<Event>`	`getEvents()` Returns the browser events that the chart should listen to for tooltips and hovering.
`Hover`	`getHover()` Returns the hover element.
`Layout`	`getLayout()` Returns the layout element.
`Legend`	`getLegend()` Returns the legend element.
`LegendCallback`	`getLegendCallback()` Returns the legend callback instance
`Plugins`	`getPlugins()` Returns the plugins element.
`int`	`getResponsiveAnimationDuration()` Returns the duration in milliseconds it takes to animate to new size after a resize event.
`Title`	`getTitle()` Returns the title element.
`Tooltips`	`getTooltips()` Returns the tooltips element.
`boolean`	`hasDatasetSelectionHandlers()` Returns `true` if there is any dataset selection handler, otherwise `false`.
`boolean`	`isMaintainAspectRatio()` Returns the the maintaining of the original canvas aspect ratio (width / height) when resizing.
`boolean`	`isResponsive()` Returns the resizing of the chart canvas when its container does.
`void`	`load(AbstractChart<?,?> chart, Configuration configuration)` Called to enable to load into a configuration object the specific configuration item (by native object).
`protected <H extends EventHandler> void`	`removeHandler(GwtEvent.Type<H> type)` Notifies the event provider when a new handler has been unregistered
`void`	`setAspectRatio(double ratio)` Canvas aspect ratio (i.e.
`protected void`	`setConfiguration(T configuration)`
`void`	`setDevicePixelRatio(double ratio)` The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g.
`void`	`setEvents(Event... events)` Sets the browser events that the chart should listen to for tooltips and hovering.
`void`	`setLegendCallback(LegendCallback legendCallback)` Sets the legend callback instance
`void`	`setMaintainAspectRatio(boolean maintainAspectRatio)` Sets the maintaining of the original canvas aspect ratio (width / height) when resizing.
`void`	`setResponsive(boolean responsive)` Sets the resizing of the chart canvas when its container does.
`void`	`setResponsiveAnimationDuration(int milliseconds)` Sets the duration in milliseconds it takes to animate to new size after a resize event.
`String`	`toJSON()` Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.EventProvider
onAdd, onRemove

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

- Method Detail
  - getAnimation
```
public Animation getAnimation()
```
    Returns the animation element.
    
    Returns:
    
    the animation
  - getHover
```
public Hover getHover()
```
    Returns the hover element.
    
    Returns:
    
    the hover
  - getLayout
```
public Layout getLayout()
```
    Returns the layout element.
    
    Returns:
    
    the layout
  - getLegend
```
public Legend getLegend()
```
    Returns the legend element.
    
    Returns:
    
    the legend
  - getTitle
```
public Title getTitle()
```
    Returns the title element.
    
    Returns:
    
    the title
  - getTooltips
```
public Tooltips getTooltips()
```
    Returns the tooltips element.
    
    Returns:
    
    the tooltips
  - getElements
```
public Elements getElements()
```
    Returns the elements element.
    
    Returns:
    
    the elements
  - getPlugins
```
public Plugins getPlugins()
```
    Returns the plugins element.
    
    Returns:
    
    the plugins
  - setEvents
```
public void setEvents(Event... events)
```
    Sets the browser events that the chart should listen to for tooltips and hovering.
    
    Parameters:
    
    events - the browser events that the chart should listen to for tooltips and hovering.
  - getEvents
```
public List<Event> getEvents()
```
    Returns the browser events that the chart should listen to for tooltips and hovering.
    
    Returns:
    
    the browser events that the chart should listen to for tooltips and hovering.
  - setResponsive
```
public void setResponsive(boolean responsive)
```
    Sets the resizing of the chart canvas when its container does.
    
    Parameters:
    
    responsive - the resizing of the chart canvas when its container does.
  - isResponsive
```
public boolean isResponsive()
```
    Returns the resizing of the chart canvas when its container does.
    
    Returns:
    
    the resizing of the chart canvas when its container does.
  - setResponsiveAnimationDuration
```
public void setResponsiveAnimationDuration(int milliseconds)
```
    Sets the duration in milliseconds it takes to animate to new size after a resize event.
    
    Parameters:
    
    milliseconds - the duration in milliseconds it takes to animate to new size after a resize event.
  - getResponsiveAnimationDuration
```
public int getResponsiveAnimationDuration()
```
    Returns the duration in milliseconds it takes to animate to new size after a resize event.
    
    Returns:
    
    the duration in milliseconds it takes to animate to new size after a resize event.
  - setMaintainAspectRatio
```
public void setMaintainAspectRatio(boolean maintainAspectRatio)
```
    Sets the maintaining of the original canvas aspect ratio (width / height) when resizing.
    
    Parameters:
    
    maintainAspectRatio - the maintaining of the original canvas aspect ratio (width / height) when resizing.
  - isMaintainAspectRatio
```
public boolean isMaintainAspectRatio()
```
    Returns the the maintaining of the original canvas aspect ratio (width / height) when resizing.
    
    Returns:
    
    the maintaining of the original canvas aspect ratio (width / height) when resizing.
  - setAspectRatio
```
public void setAspectRatio(double ratio)
```
    Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas).
    Note that this option is ignored if the height is explicitly defined either as attribute or via the style.
    
    Parameters:
    
    ratio - the aspect ratio.
  - getAspectRatio
```
public double getAspectRatio()
```
    Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas).
    Note that this option is ignored if the height is explicitly defined either as attribute or via the style.
    
    Returns:
    
    the aspect ratio.
  - setDevicePixelRatio
```
public void setDevicePixelRatio(double ratio)
```
    The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g. Retina displays). Setting devicePixelRatio to a value other than 1 will force the canvas size to be scaled by that amount.
    
    Parameters:
    
    ratio - the pixel ratio.
  - getDevicePixelRatio
```
public double getDevicePixelRatio()
```
    The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g. Retina displays). Setting devicePixelRatio to a value other than 1 will force the canvas size to be scaled by that amount. Returns the pixel ratio.
    
    Returns:
    
    the pixel ratio..
  - hasDatasetSelectionHandlers
```
public final boolean hasDatasetSelectionHandlers()
```
    Returns true if there is any dataset selection handler, otherwise false.
    
    Returns:
    
    true if there is any dataset selection handler, otherwise false.
  - addHandler
```
protected final <H extends EventHandler> void addHandler(GwtEvent.Type<H> type)
```
    Description copied from class: EventProvider
    
    Notifies the event provider when a new handler has been added.
    
    Specified by:
    
    addHandler in class EventProvider<ExtendedOptions>
    
    Type Parameters:
    
    H - type of event handler
    
    Parameters:
    
    type - type of event
  - removeHandler
```
protected final <H extends EventHandler> void removeHandler(GwtEvent.Type<H> type)
```
    Description copied from class: EventProvider
    
    Notifies the event provider when a new handler has been unregistered
    
    Specified by:
    
    removeHandler in class EventProvider<ExtendedOptions>
    
    Type Parameters:
    
    H - type of event handler
    
    Parameters:
    
    type - type of event handler
  - getLegendCallback
```
public LegendCallback getLegendCallback()
```
    Returns the legend callback instance
    
    Returns:
    
    the legendCallBack
  - setLegendCallback
```
public void setLegendCallback(LegendCallback legendCallback)
```
    Sets the legend callback instance
    
    Parameters:
    
    legendCallback - the legendCallBack to set
  - load
```
public void load(AbstractChart<?,?> chart,
                 Configuration configuration)
```
    Description copied from interface: ConfigurationElement
    
    Called to enable to load into a configuration object the specific configuration item (by native object).
    
    Specified by:
    
    load in interface ConfigurationElement
    
    Parameters:
    
    chart - chart instance
    
    configuration - chart configuration instance
  - setConfiguration
```
protected final void setConfiguration(T configuration)
```
    Parameters:
    
    configuration - the configuration to set
  - getConfiguration
```
protected final T getConfiguration()
```
    Returns the configuration element.
    
    Returns:
    
    the configuration element.
  - toJSON
```
public final String toJSON()
```
    Returns the JSON representation of the object.
    
    Returns:
    
    the JSON representation of the object.
  - getChart
```
public final AbstractChart<?,?> getChart()
```
    Returns the chart instance
    
    Returns:
    
    the chart

Class ConfigurationOptions

Method Summary

Methods inherited from class org.pepstock.charba.client.configuration.EventProvider

Methods inherited from class java.lang.Object

Method Detail

getAnimation

getHover

getLayout

getLegend

getTitle

getTooltips

getElements

getPlugins

setEvents

getEvents

setResponsive

isResponsive

setResponsiveAnimationDuration

getResponsiveAnimationDuration

setMaintainAspectRatio

isMaintainAspectRatio

setAspectRatio

getAspectRatio

setDevicePixelRatio

getDevicePixelRatio

hasDatasetSelectionHandlers

addHandler

removeHandler

getLegendCallback

setLegendCallback

load

setConfiguration

getConfiguration

toJSON

getChart