BaseOptions (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.JavaScriptObjectContainer
- - org.pepstock.charba.client.commons.ChartContainer
  - - org.pepstock.charba.client.commons.EventProvider
    - - org.pepstock.charba.client.options.BaseOptions

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

Direct Known Subclasses:

DoughnutOptions, MeterOptions, MultiScalesOptions, PieOptions, SingleScaleOptions, StackedOptions
```
public abstract class BaseOptions
extends EventProvider
```
Base object which maps chart options.
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

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseOptions(AbstractChart<?,?> chart)
Builds the object storing the chart instance.
Sets also the internal parts of options.

Constructors
Modifier	Constructor and Description
`protected`	`BaseOptions(AbstractChart<?,?> chart)` Builds the object storing the chart instance. Sets also the internal parts of options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected <H extends com.google.gwt.event.shared.EventHandler> void`	`addHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type)` Notifies the event provider when a new handler has been added.
`protected java.lang.String`	`generateLegend()` Called to generate an HTML legend.
`Animation`	`getAnimation()`
`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()`
`JsEnumValueArrayList<Event>`	`getEvents()` Returns the browser events that the chart should listen to for tooltips and hovering.
`Hover`	`getHover()`
`Layout`	`getLayout()`
`Legend`	`getLegend()`
`LegendCallback`	`getLegendCallBack()`
`Plugins`	`getPlugins()`
`int`	`getResponsiveAnimationDuration()` Returns the duration in milliseconds it takes to animate to new size after a resize event.
`Title`	`getTitle()`
`Tooltips`	`getTooltips()`
`boolean`	`isAnimationEnable()` Returns if should chart be animated or not Default value is `true`.
`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.
`protected void`	`onClick(ChartNativeEvent event, GenericJavaScriptObject metadata)` Called if the event is of type 'mouseup' or 'click'.
`protected void`	`onHover(ChartNativeEvent event, GenericJavaScriptObject metadata)` Called when any of the events fire.
`protected void`	`onItemClick(ChartNativeEvent event, GenericJavaScriptObject object)` Called if the event is of type 'mouseup' or 'click'.
`protected void`	`onResize(GenericJavaScriptObject item)` Called when a resize occurs.
`protected <H extends com.google.gwt.event.shared.EventHandler> void`	`removeHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type)` Notifies the event provider when a new handler has been deregistered
`void`	`setAnimationEnabled(boolean enabled)` Specify should chart be animated or not Default value is `true`.
`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)`
`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.

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

Methods inherited from class org.pepstock.charba.client.commons.ChartContainer
getChart

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer
checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

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

- Constructor Detail
  - BaseOptions
```
protected BaseOptions(AbstractChart<?,?> chart)
```
    Builds the object storing the chart instance.
    Sets also the internal parts of options.
    
    Parameters:
    
    chart - chart instance
- Method Detail
  - getAnimation
```
public Animation getAnimation()
```
    Returns:
    
    the animation
  - getHover
```
public Hover getHover()
```
    Returns:
    
    the hover
  - getLayout
```
public Layout getLayout()
```
    Returns:
    
    the layout
  - getLegend
```
public Legend getLegend()
```
    Returns:
    
    the legend
  - getTitle
```
public Title getTitle()
```
    Returns:
    
    the title
  - getTooltips
```
public Tooltips getTooltips()
```
    Returns:
    
    the tooltip
  - getElements
```
public Elements getElements()
```
    Returns:
    
    the elements
  - getPlugins
```
public Plugins getPlugins()
```
    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 JsEnumValueArrayList<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. Default is Options.getEvents().
  - getLegendCallBack
```
public LegendCallback getLegendCallBack()
```
    Returns:
    
    the legendCallBack
  - setLegendCallBack
```
public void setLegendCallBack(LegendCallback legendCallBack)
```
    Parameters:
    
    legendCallBack - the legendCallBack to set
  - setAnimationEnabled
```
public void setAnimationEnabled(boolean enabled)
```
    Specify should chart be animated or not Default value is true.
    
    Parameters:
    
    enabled - Specify should chart be animated or not.
  - isAnimationEnable
```
public boolean isAnimationEnable()
```
    Returns if should chart be animated or not Default value is true.
    
    Returns:
    
    if should chart be animated or not Default value is true.
  - 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. Default is Options.isResponsive().
  - 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. Default is Options.getResponsiveAnimationDuration().
  - 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. Default is Options.isMaintainAspectRatio().
  - 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. Default is Default is Options.getDevicePixelRatio()..
  - addHandler
```
protected <H extends com.google.gwt.event.shared.EventHandler> void addHandler(com.google.gwt.event.shared.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
    
    Type Parameters:
    
    H - type of event handler
    
    Parameters:
    
    type - type of event
  - removeHandler
```
protected <H extends com.google.gwt.event.shared.EventHandler> void removeHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type)
```
    Description copied from class: EventProvider
    
    Notifies the event provider when a new handler has been deregistered
    
    Specified by:
    
    removeHandler in class EventProvider
    
    Type Parameters:
    
    H - type of event handler
    
    Parameters:
    
    type - type of event handler
  - onHover
```
protected void onHover(ChartNativeEvent event,
                       GenericJavaScriptObject metadata)
```
    Called when any of the events fire. Called in the context of the chart and passed the event and an array of active elements (bars, points, etc).
    
    Parameters:
    
    event - event generated by chart.
    
    metadata - dataset meta data.
  - onClick
```
protected void onClick(ChartNativeEvent event,
                       GenericJavaScriptObject metadata)
```
    Called if the event is of type 'mouseup' or 'click'. Called in the context of the chart and passed the event and an array of active elements.
    
    Parameters:
    
    event - event generated by chart.
    
    metadata - dataset meta data.
  - onItemClick
```
protected void onItemClick(ChartNativeEvent event,
                           GenericJavaScriptObject object)
```
    Called if the event is of type 'mouseup' or 'click'. Called in the context of the chart and passed the event and an active element.
    
    Parameters:
    
    event - event generated by chart.
    
    object - java script object dataset meta data.
  - onResize
```
protected void onResize(GenericJavaScriptObject item)
```
    Called when a resize occurs. Gets passed the new size.
    
    Parameters:
    
    item - the new size item.
  - generateLegend
```
protected java.lang.String generateLegend()
```
    Called to generate an HTML legend.
    
    Returns:
    
    an HTML string which represents the legend.

Class BaseOptions

Constructor Summary

Method Summary

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

Methods inherited from class org.pepstock.charba.client.commons.ChartContainer

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer

Methods inherited from class java.lang.Object

Constructor Detail

BaseOptions

Method Detail

getAnimation

getHover

getLayout

getLegend

getTitle

getTooltips

getElements

getPlugins

setEvents

getEvents

getLegendCallBack

setLegendCallBack

setAnimationEnabled

isAnimationEnable

setResponsive

isResponsive

setResponsiveAnimationDuration

getResponsiveAnimationDuration

setMaintainAspectRatio

isMaintainAspectRatio

setDevicePixelRatio

getDevicePixelRatio

addHandler

removeHandler

onHover

onClick

onItemClick

onResize

generateLegend