Options (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.JavaScriptObjectContainer
- - org.pepstock.charba.client.defaults.AbstractItem
  - - org.pepstock.charba.client.defaults.global.Options

Direct Known Subclasses:

GlobalOptions, OptionsNode
```
public class Options
extends AbstractItem
```
Base object which maps chart options.
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.
It maps the CHART.JS object of default, chart.defaults.global.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Constructor and Description
`Options(GenericJavaScriptObject javaScriptObject)` Creates the object using the java script object with the defaults provided by CHART.JS. It's a root element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Animation`	`getAnimation()`
`double`	`getCircumference()` Returns the the sweep to allow arcs to cover.
`double`	`getCutoutPercentage()` Returns the the percentage of the chart that is cut out of the middle.
`IsColor`	`getDefaultColor()` Returns the default color to use in the chart, on all objects, if not override by the specific configuration.
`java.lang.String`	`getDefaultColorAsString()` Returns the default color to use in the chart, on all objects, if not override by the specific configuration.
`IsColor`	`getDefaultFontColor()` Returns the default font color to use in the chart, on all objects, if not override by the specific configuration.
`java.lang.String`	`getDefaultFontColorAsString()` Returns the default font color to use in the chart, on all objects, if not override by the specific configuration.
`java.lang.String`	`getDefaultFontFamily()` Returns the font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options.
`int`	`getDefaultFontSize()` Returns the font size to use in the chart, on all objects, if not override by the specific configuration.
`FontStyle`	`getDefaultFontStyle()` Returns the font style to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-style options (i.e.
`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()`
`int`	`getResponsiveAnimationDuration()` Returns the duration in milliseconds it takes to animate to new size after a resize event.
`double`	`getRotation()` Returns the starting angle to draw arcs from.
`Scale`	`getScale()`
`Scales`	`getScales()`
`double`	`getStartAngle()` Returns the starting angle to draw arcs for the first item in a dataset.
`Title`	`getTitle()`
`Tooltips`	`getTooltips()`
`boolean`	`isAnimationEnable()` Returns if should chart be animated or not.
`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.
`boolean`	`isShowLines()` If false, the lines between points are not drawn.
`boolean`	`isSpanGaps()` If false, NaN data causes a break in the line.
`void`	`setCircumference(double circumference)` Sets the sweep to allow arcs to cover.
`void`	`setCutoutPercentage(double cutoutPercentage)` Sets the percentage of the chart that is cut out of the middle.
`void`	`setDefaultColor(IsColor defaultColor)` Sets the default color to use in the chart, on all objects, if not override by the specific configuration.
`void`	`setDefaultColor(java.lang.String defaultColor)` Sets the default color to use in the chart, on all objects, if not override by the specific configuration.
`void`	`setDefaultFontColor(IsColor defaultFontColor)` Sets the default font color to use in the chart, on all objects, if not override by the specific configuration.
`void`	`setDefaultFontColor(java.lang.String defaultFontColor)` Sets the default font color to use in the chart, on all objects, if not override by the specific configuration.
`void`	`setDefaultFontFamily(java.lang.String fontFamily)` Sets the font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options.
`void`	`setDefaultFontSize(int fontSize)` Sets the font size to use in the chart, on all objects, if not override by the specific configuration.
`void`	`setDefaultFontStyle(FontStyle fontStyle)` Sets the font style to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-style options (i.e.
`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`	`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.
`void`	`setRotation(double rotation)` Sets the starting angle to draw arcs from.
`void`	`setShowLines(boolean showLine)` If false, the lines between points are not drawn.
`void`	`setSpanGaps(boolean spanGaps)` If false, NaN data causes a break in the line.
`void`	`setStartAngle(double startAngle)` Sets the starting angle to draw arcs for the first item in a dataset.

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem
checkAndAddToParent, hasProperty

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
  - Options
```
public Options(GenericJavaScriptObject javaScriptObject)
```
    Creates the object using the java script object with the defaults provided by CHART.JS.
    It's a root element.
    
    Parameters:
    
    javaScriptObject - the java script object with the defaults provided by CHART.JS.
- Method Detail
  - getHover
```
public Hover getHover()
```
    Returns:
    
    the hover
  - getElements
```
public Elements getElements()
```
    Returns:
    
    the elements
  - getLayout
```
public Layout getLayout()
```
    Returns:
    
    the layout
  - getAnimation
```
public Animation getAnimation()
```
    Returns:
    
    the animation
  - getTooltips
```
public Tooltips getTooltips()
```
    Returns:
    
    the tooltips
  - getTitle
```
public Title getTitle()
```
    Returns:
    
    the title
  - getLegend
```
public Legend getLegend()
```
    Returns:
    
    the legend
  - getScale
```
public Scale getScale()
```
    Returns:
    
    the scale
  - getScales
```
public Scales getScales()
```
    Returns:
    
    the scales
  - 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.
  - isAnimationEnable
```
public boolean isAnimationEnable()
```
    Returns if should chart be animated or not.
    
    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 true.
  - 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 0.
  - 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 true.
  - 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 window.devicePixelRatio.
  - setDefaultColor
```
public void setDefaultColor(IsColor defaultColor)
```
    Sets the default color to use in the chart, on all objects, if not override by the specific configuration.
    
    Parameters:
    
    defaultColor - color to use into chart.
  - setDefaultColor
```
public void setDefaultColor(java.lang.String defaultColor)
```
    Sets the default color to use in the chart, on all objects, if not override by the specific configuration.
    
    Parameters:
    
    defaultColor - color to use into chart.
  - getDefaultColorAsString
```
public java.lang.String getDefaultColorAsString()
```
    Returns the default color to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    color to use into chart. Default is "rgba(0,0,0,0.1)"
  - getDefaultColor
```
public IsColor getDefaultColor()
```
    Returns the default color to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    color to use into chart. Default is "rgba(0,0,0,0.1)"
  - setDefaultFontColor
```
public void setDefaultFontColor(IsColor defaultFontColor)
```
    Sets the default font color to use in the chart, on all objects, if not override by the specific configuration.
    
    Parameters:
    
    defaultFontColor - font color to use into chart.
  - setDefaultFontColor
```
public void setDefaultFontColor(java.lang.String defaultFontColor)
```
    Sets the default font color to use in the chart, on all objects, if not override by the specific configuration.
    
    Parameters:
    
    defaultFontColor - font color to use into chart.
  - getDefaultFontColorAsString
```
public java.lang.String getDefaultFontColorAsString()
```
    Returns the default font color to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    font color to use into chart. Default is #666.
  - getDefaultFontColor
```
public IsColor getDefaultFontColor()
```
    Returns the default font color to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    font color to use into chart. Default is #666.
  - setDefaultFontSize
```
public void setDefaultFontSize(int fontSize)
```
    Sets the font size to use in the chart, on all objects, if not override by the specific configuration.
    
    Parameters:
    
    fontSize - Font size into chart.
  - getDefaultFontSize
```
public int getDefaultFontSize()
```
    Returns the font size to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    Font size into chart. Default is 12.
  - setDefaultFontStyle
```
public void setDefaultFontStyle(FontStyle fontStyle)
```
    Sets the font style to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    Parameters:
    
    fontStyle - Font style to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    See Also:
    
    FontStyle
  - getDefaultFontStyle
```
public FontStyle getDefaultFontStyle()
```
    Returns the font style to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    Returns:
    
    the font styleto use in the chart, on all objects, if not override by the specific configuration, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit). Default is FontStyle.normal.
    
    See Also:
    
    FontStyle
  - setDefaultFontFamily
```
public void setDefaultFontFamily(java.lang.String fontFamily)
```
    Sets the font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options.
    
    Parameters:
    
    fontFamily - Font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options.
  - getDefaultFontFamily
```
public java.lang.String getDefaultFontFamily()
```
    Returns the font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options.
    
    Returns:
    
    Font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options. Default is 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif
  - setShowLines
```
public void setShowLines(boolean showLine)
```
    If false, the lines between points are not drawn.
    
    Parameters:
    
    showLine - If false, the lines between points are not drawn.
  - isShowLines
```
public boolean isShowLines()
```
    If false, the lines between points are not drawn.
    
    Returns:
    
    If false, the lines between points are not drawn. Default is true.
  - setSpanGaps
```
public void setSpanGaps(boolean spanGaps)
```
    If false, NaN data causes a break in the line.
    
    Parameters:
    
    spanGaps - If false, NaN data causes a break in the line.
  - isSpanGaps
```
public boolean isSpanGaps()
```
    If false, NaN data causes a break in the line.
    
    Returns:
    
    If false, NaN data causes a break in the line. Default is false.
  - setCutoutPercentage
```
public void setCutoutPercentage(double cutoutPercentage)
```
    Sets the percentage of the chart that is cut out of the middle.
    
    Parameters:
    
    cutoutPercentage - the percentage of the chart that is cut out of the middle.
  - getCutoutPercentage
```
public double getCutoutPercentage()
```
    Returns the the percentage of the chart that is cut out of the middle.
    
    Returns:
    
    the percentage of the chart that is cut out of the middle. Default is 0.
  - setRotation
```
public void setRotation(double rotation)
```
    Sets the starting angle to draw arcs from.
    
    Parameters:
    
    rotation - starting angle to draw arcs from.
  - getRotation
```
public double getRotation()
```
    Returns the starting angle to draw arcs from.
    
    Returns:
    
    starting angle to draw arcs from. Default is -0.5 * Math.PI.
  - setCircumference
```
public void setCircumference(double circumference)
```
    Sets the sweep to allow arcs to cover.
    
    Parameters:
    
    circumference - the sweep to allow arcs to cover.
  - getCircumference
```
public double getCircumference()
```
    Returns the the sweep to allow arcs to cover.
    
    Returns:
    
    the sweep to allow arcs to cover. Default is 2 * Math.PI.
  - setStartAngle
```
public void setStartAngle(double startAngle)
```
    Sets the starting angle to draw arcs for the first item in a dataset.
    
    Parameters:
    
    startAngle - starting angle to draw arcs for the first item in a dataset.
  - getStartAngle
```
public double getStartAngle()
```
    Returns the starting angle to draw arcs for the first item in a dataset.
    
    Returns:
    
    starting angle to draw arcs for the first item in a dataset. Default is -0.5 * Math.PI.

Class Options

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

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

Methods inherited from class java.lang.Object

Constructor Detail

Options

Method Detail

getHover

getElements

getLayout

getAnimation

getTooltips

getTitle

getLegend

getScale

getScales

setEvents

getEvents

isAnimationEnable

setResponsive

isResponsive

setResponsiveAnimationDuration

getResponsiveAnimationDuration

setMaintainAspectRatio

isMaintainAspectRatio

setDevicePixelRatio

getDevicePixelRatio

setDefaultColor

setDefaultColor

getDefaultColorAsString

getDefaultColor

setDefaultFontColor

setDefaultFontColor

getDefaultFontColorAsString

getDefaultFontColor

setDefaultFontSize

getDefaultFontSize

setDefaultFontStyle

getDefaultFontStyle

setDefaultFontFamily

getDefaultFontFamily

setShowLines

isShowLines

setSpanGaps

isSpanGaps

setCutoutPercentage

getCutoutPercentage

setRotation

getRotation

setCircumference

getCircumference

setStartAngle

getStartAngle