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

java.lang.Object
- org.pepstock.charba.client.configuration.ConfigurationOptions

All Implemented Interfaces:

ConfigurationElement

Direct Known Subclasses:

AbstractPieOptions, BarOptions, BubbleOptions, LineOptions, ScatterOptions, SingleScaleOptions, StackedOptions, TimeSeriesBarOptions, TimeSeriesLineOptions
```
public abstract class ConfigurationOptions
extends Object
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 Static Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`Animation`	`getAnimation()` Returns the animation element.
`double`	`getAspectRatio()` Canvas aspect ratio (i.e.
`IsChart`	`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`	`hasAxisClickHandlers()` Returns `true` if there is any axis click handler, otherwise `false`.
`boolean`	`hasDatasetSelectionHandlers()` Returns `true` if there is any dataset selection handler, otherwise `false`.
`boolean`	`hasTitleClickHandlers()` Returns `true` if there is any title click handler, otherwise `false`.
`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`	`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(IsChart chart, Configuration configuration)` Called to enable to load into a configuration object the specific configuration item (by native object).
`void`	`loadOptions(OptionsEnvelop envelop)` Merges chart default options (by chart.defaults[type]), default scale options (by chart.defaults.scale) and global options (by chart.defaults.global) and chart options. The chain of priority is: chart options chart default options (by chart.defaults[type]) default scale options (by chart.defaults.scale) global options (by chart.defaults.global)
`void`	`merge(NativeObjectContainer source, String property)` Merge a native object into this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.
`void`	`onAdd(AddHandlerEvent event)` Invoked when a new event handler is added.
`void`	`onRemove(RemoveHandlerEvent event)` Invoked when a chart event handler is removed.
`static void`	`register(IsChart chart, org.pepstock.charba.client.configuration.IsEventProvider provider)` Adds the event provider implementation as handlers of chart.
`void`	`setAspectRatio(double ratio)` Canvas aspect ratio (i.e.
`protected void`	`setConfiguration(T configuration)`
`void`	`setDestroyOnDetach(boolean destroyOnDetach)` Sets `true` if the chart is configured to be destroyed on the detach from DIV element, otherwise `false`.
`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`	`setDrawOnAttach(boolean drawOnAttach)` Sets `true` if the chart is configured to be draw on the attach of DIV element, otherwise `false`.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - loadOptions
```
public final void loadOptions(OptionsEnvelop envelop)
```
    Merges chart default options (by chart.defaults[type]), default scale options (by chart.defaults.scale) and global options (by chart.defaults.global) and chart options.
    The chain of priority is:
    - chart options
    - chart default options (by chart.defaults[type])
    - default scale options (by chart.defaults.scale)
    - global options (by chart.defaults.global)
    Parameters:
    
    envelop - the envelop for options as native options
  - 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..
  - isDrawOnAttach
```
public 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
```
public 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
```
public boolean isDestroyOnDetach()
```
    Returns true if the chart is configured to be destroyed on the detach from DIV element, otherwise false.
    
    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 void setDestroyOnDetach(boolean destroyOnDetach)
```
    Sets true if the chart is configured to be destroyed on the detach from DIV element, otherwise false.
    
    Parameters:
    
    destroyOnDetach - the destroyOnDetach to set
  - 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.
  - hasTitleClickHandlers
```
public final boolean hasTitleClickHandlers()
```
    Returns true if there is any title click handler, otherwise false.
    
    Returns:
    
    true if there is any title click handler, otherwise false.
  - hasAxisClickHandlers
```
public final boolean hasAxisClickHandlers()
```
    Returns true if there is any axis click handler, otherwise false.
    
    Returns:
    
    true if there is any axis click handler, otherwise false.
  - onAdd
```
public final void onAdd(AddHandlerEvent event)
```
    Description copied from interface: AddHandlerEventHandler
    
    Invoked when a new event handler is added.
    
    Parameters:
    
    event - event to be consumed
  - onRemove
```
public final void onRemove(RemoveHandlerEvent event)
```
    Description copied from interface: RemoveHandlerEventHandler
    
    Invoked when a chart event handler is removed.
    
    Parameters:
    
    event - event to be consumed
  - 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(IsChart 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
  - register
```
public static void register(IsChart chart,
                            org.pepstock.charba.client.configuration.IsEventProvider provider)
```
    Adds the event provider implementation as handlers of chart.
    
    Parameters:
    
    chart - chart instance
    
    provider - event provider implmentation
  - 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.
  - merge
```
public final void merge(NativeObjectContainer source,
                        String property)
```
    Merge a native object into this one with a specific property name.
    This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.
    
    Parameters:
    
    source - native object container to add
    
    property - property name
  - toJSON
```
public final String toJSON()
```
    Returns the JSON representation of the object.
    
    Returns:
    
    the JSON representation of the object.
  - getChart
```
public final IsChart getChart()
```
    Returns the chart instance
    
    Returns:
    
    the chart

Class ConfigurationOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

loadOptions

getAnimation

getHover

getLayout

getLegend

getTitle

getTooltips

getElements

getPlugins

setEvents

getEvents

setResponsive

isResponsive

setResponsiveAnimationDuration

getResponsiveAnimationDuration

setMaintainAspectRatio

isMaintainAspectRatio

setAspectRatio

getAspectRatio

setDevicePixelRatio

getDevicePixelRatio

isDrawOnAttach

setDrawOnAttach

isDestroyOnDetach

setDestroyOnDetach

hasDatasetSelectionHandlers

hasTitleClickHandlers

hasAxisClickHandlers

onAdd

onRemove

getLegendCallback

setLegendCallback

load

register

setConfiguration

getConfiguration

merge

toJSON

getChart