Options (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.Options

All Implemented Interfaces:

IsDefaultOptions

Direct Known Subclasses:

GlobalOptions, ScaledOptions
```
public class Options
extends NativeObjectContainer
implements IsDefaultOptions
```
Base object which maps chart options.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Options(IsDefaultOptions defaultValues)` Creates the object only with default provider.
`protected`	`Options(IsDefaultOptions defaultValues, NativeObject nativeObject)` Creates the object only with default provider and native object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkAndAddToParent()` Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
`Animation`	`getAnimation()` Returns the animation element.
`double`	`getAspectRatio()` Canvas aspect ratio (i.e.
`String`	`getCharbaId()` Returns the CHARBA id when the options are related to a chart instance.
`protected Key`	`getChildKey()` Returns the property name to use to add this element to its parent.
`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.
`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.
`String`	`getDefaultFontColorAsString()` Returns the default font color to use in the chart, on all objects, if not override by the specific configuration.
`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.
`protected D`	`getDefaultValues()` Returns the default provider instance.
`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.
`protected P`	`getParent()` Returns the parent element.
`Plugins`	`getPlugins()` Returns the plugins element.
`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.
`double`	`getStartAngle()` Returns the starting angle to draw arcs for the first item in a dataset.
`Title`	`getTitle()` Returns the title element.
`Tooltips`	`getTooltips()` Returns the tooltips element.
`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`	`setAspectRatio(double ratio)` Canvas aspect ratio (i.e.
`protected void`	`setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for callbacks) to a model at the specific key.
`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(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(String defaultFontColor)` Sets the default font color to use in the chart, on all objects, if not override by the specific configuration.
`void`	`setDefaultFontFamily(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.
`protected void`	`setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for events) to a model at the specific key.
`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.commons.NativeObjectContainer
checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

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

- Constructor Detail
  - Options
```
protected Options(IsDefaultOptions defaultValues)
```
    Creates the object only with default provider. This is used as the root element.
    New native java script object is created and it's empty.
    
    Parameters:
    
    defaultValues - default provider instance.
  - Options
```
protected Options(IsDefaultOptions defaultValues,
                  NativeObject nativeObject)
```
    Creates the object only with default provider and native object. This is used as the root element.
    
    Parameters:
    
    defaultValues - default provider instance.
    
    nativeObject - native object to store properties.
- Method Detail
  - getAnimation
```
public Animation getAnimation()
```
    Returns the animation element.
    
    Specified by:
    
    getAnimation in interface IsDefaultOptions
    
    Returns:
    
    the animation
  - getLegend
```
public Legend getLegend()
```
    Returns the legend element.
    
    Specified by:
    
    getLegend in interface IsDefaultOptions
    
    Returns:
    
    the legend
  - getHover
```
public final Hover getHover()
```
    Returns the hover element.
    
    Specified by:
    
    getHover in interface IsDefaultOptions
    
    Returns:
    
    the hover
  - getLayout
```
public final Layout getLayout()
```
    Returns the layout element.
    
    Specified by:
    
    getLayout in interface IsDefaultOptions
    
    Returns:
    
    the layout
  - getElements
```
public final Elements getElements()
```
    Returns the elements element.
    
    Specified by:
    
    getElements in interface IsDefaultOptions
    
    Returns:
    
    the elements
  - getTitle
```
public final Title getTitle()
```
    Returns the title element.
    
    Specified by:
    
    getTitle in interface IsDefaultOptions
    
    Returns:
    
    the title
  - getTooltips
```
public final Tooltips getTooltips()
```
    Returns the tooltips element.
    
    Specified by:
    
    getTooltips in interface IsDefaultOptions
    
    Returns:
    
    the tooltips
  - getPlugins
```
public final Plugins getPlugins()
```
    Returns the plugins element.
    
    Returns:
    
    the plugins
  - getCharbaId
```
public String getCharbaId()
```
    Returns the CHARBA id when the options are related to a chart instance.
    
    Returns:
    
    the CHARBA id when the options are related to a chart instance otherwise UndefinedValues.STRING.
  - 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.
    
    Specified by:
    
    isResponsive in interface IsDefaultOptions
    
    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.
    
    Specified by:
    
    getResponsiveAnimationDuration in interface IsDefaultOptions
    
    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.
    
    Specified by:
    
    isMaintainAspectRatio in interface IsDefaultOptions
    
    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.
    
    Specified by:
    
    getAspectRatio in interface IsDefaultOptions
    
    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.
    
    Specified by:
    
    getDevicePixelRatio in interface IsDefaultOptions
    
    Returns:
    
    the pixel ratio.
  - 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(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 String getDefaultColorAsString()
```
    Returns the default color to use in the chart, on all objects, if not override by the specific configuration.
    
    Specified by:
    
    getDefaultColorAsString in interface IsDefaultOptions
    
    Returns:
    
    color to use into chart.
  - 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.
  - 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(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 String getDefaultFontColorAsString()
```
    Returns the default font color to use in the chart, on all objects, if not override by the specific configuration.
    
    Specified by:
    
    getDefaultFontColorAsString in interface IsDefaultOptions
    
    Returns:
    
    font color to use into chart.
  - 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.
  - 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.
    
    Specified by:
    
    getDefaultFontSize in interface IsDefaultOptions
    
    Returns:
    
    font size into chart.
  - 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).
  - 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).
    
    Specified by:
    
    getDefaultFontStyle in interface IsDefaultOptions
    
    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).
  - setDefaultFontFamily
```
public void setDefaultFontFamily(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 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.
    
    Specified by:
    
    getDefaultFontFamily in interface IsDefaultOptions
    
    Returns:
    
    Font family to use in the chart, on all objects, if not override by the specific configuration, follows CSS font-family options.
  - 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.
    
    Specified by:
    
    isShowLines in interface IsDefaultOptions
    
    Returns:
    
    if false, the lines between points are not drawn..
  - 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.
    
    Specified by:
    
    isSpanGaps in interface IsDefaultOptions
    
    Returns:
    
    if false, NaN data causes a break in the line.
  - 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.
    
    Specified by:
    
    getCutoutPercentage in interface IsDefaultOptions
    
    Returns:
    
    the percentage of the chart that is cut out of the middle.
  - 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.
    
    Specified by:
    
    getRotation in interface IsDefaultOptions
    
    Returns:
    
    starting angle to draw arcs from.
  - 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.
    
    Specified by:
    
    getCircumference in interface IsDefaultOptions
    
    Returns:
    
    the sweep to allow arcs to cover.
  - 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.
    
    Specified by:
    
    getStartAngle in interface IsDefaultOptions
    
    Returns:
    
    starting angle to draw arcs for the first item in a dataset.
  - getChildKey
```
protected final Key getChildKey()
```
    Returns the property name to use to add this element to its parent.
    
    Returns:
    
    the childKey or null if is a root element.
  - getParent
```
protected final P getParent()
```
    Returns the parent element.
    
    Returns:
    
    the parent or null if is a root element.
  - getDefaultValues
```
protected final D getDefaultValues()
```
    Returns the default provider instance.
    
    Returns:
    
    the default provider instance.
  - setEventToModel
```
protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for events) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - setCallbackToModel
```
protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for callbacks) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - checkAndAddToParent
```
protected final void checkAndAddToParent()
```
    Called recursively when a property has been set in the item.
    This is mandatory because it could happen that the parent item is not present, therefore it must be added.

Class Options

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Options

Options

Method Detail

getAnimation

getLegend

getHover

getLayout

getElements

getTitle

getTooltips

getPlugins

getCharbaId

setEvents

getEvents

setResponsive

isResponsive

setResponsiveAnimationDuration

getResponsiveAnimationDuration

setMaintainAspectRatio

isMaintainAspectRatio

setAspectRatio

getAspectRatio

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

getChildKey

getParent

getDefaultValues

setEventToModel

setCallbackToModel

checkAndAddToParent