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

java.lang.Object
- org.pepstock.charba.client.defaults.globals.AbstractDefaultOptions
- - org.pepstock.charba.client.defaults.chart.DefaultChartOptions

All Implemented Interfaces:

IsDefaultOptions, IsDefaultScaledOptions
```
public final class DefaultChartOptions
extends AbstractDefaultOptions
implements IsDefaultScaledOptions
```
Defaults for options element, based on chart type. THIS IS THE ROOT OF ALL ELEMENTS DEFAULTS, for chart defaults.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Constructor and Description
`DefaultChartOptions(ChartOptions chartOptions)` Creates the default by a chart options instance, which represents the global options of a chart.
`DefaultChartOptions(ExtendedOptions chartOptions)` Creates the default by an extended options instance, which represents the whole options of a chart.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAspectRatio()` Canvas aspect ratio (i.e.
`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.
`String`	`getDefaultColorAsString()` Returns the default 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.
`double`	`getDefaultLineHeight()` Returns the height of an individual line of text.
`double`	`getDevicePixelRatio()` The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g.
`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.
`IsDefaultScale`	`getScale()` Returns the scale/axis defaults.
`IsDefaultScales`	`getScales()` Returns the scale/axis defaults.
`double`	`getStartAngle()` Returns the starting angle to draw arcs for the first item in a dataset.
`boolean`	`isDestroyOnDetach()` Returns `true` if the chart is configured to be destroyed on the attach of 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.
`boolean`	`isShowLines()` If false, the lines between points are not drawn.
`boolean`	`isSpanGaps()` If false, NaN data causes a break in the line.

Methods inherited from class org.pepstock.charba.client.defaults.globals.AbstractDefaultOptions
getAnimation, getElements, getHover, getLayout, getLegend, getPlugins, getTitle, getTooltips

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultOptions
getAnimation, getAspectRatio, getCircumference, getCutoutPercentage, getDefaultColorAsString, getDefaultFontColorAsString, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyle, getDefaultLineHeight, getDevicePixelRatio, getElements, getHover, getLayout, getLegend, getPlugins, getResponsiveAnimationDuration, getRotation, getStartAngle, getTitle, getTooltips, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, isShowLines, isSpanGaps

- Constructor Detail
  - DefaultChartOptions
```
public DefaultChartOptions(ExtendedOptions chartOptions)
```
    Creates the default by an extended options instance, which represents the whole options of a chart.
    
    Parameters:
    
    chartOptions - whole chart options instance.
  - DefaultChartOptions
```
public DefaultChartOptions(ChartOptions chartOptions)
```
    Creates the default by a chart options instance, which represents the global options of a chart.
    
    Parameters:
    
    chartOptions - global chart options instance.
- Method Detail
  - getScale
```
public IsDefaultScale getScale()
```
    Description copied from interface: IsDefaultScaledOptions
    
    Returns the scale/axis defaults.
    
    Specified by:
    
    getScale in interface IsDefaultScaledOptions
    
    Returns:
    
    the scale/axis defaults.
  - getScales
```
public IsDefaultScales getScales()
```
    Description copied from interface: IsDefaultScaledOptions
    
    Returns the scale/axis defaults.
    
    Specified by:
    
    getScales in interface IsDefaultScaledOptions
    
    Returns:
    
    the scale/axis defaults.
  - isResponsive
```
public final boolean isResponsive()
```
    Description copied from interface: IsDefaultOptions
    
    Returns the resizing of the chart canvas when its container does.
    
    Returns:
    
    the resizing of the chart canvas when its container does.
  - getResponsiveAnimationDuration
```
public final int getResponsiveAnimationDuration()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - isMaintainAspectRatio
```
public final boolean isMaintainAspectRatio()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getAspectRatio
```
public final double getAspectRatio()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getDevicePixelRatio
```
public final double getDevicePixelRatio()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getDefaultColorAsString
```
public final String getDefaultColorAsString()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getDefaultFontColorAsString
```
public final String getDefaultFontColorAsString()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getDefaultFontSize
```
public final int getDefaultFontSize()
```
    Description copied from interface: IsDefaultOptions
    
    Returns the font size to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    Font size into chart.
  - getDefaultFontStyle
```
public final FontStyle getDefaultFontStyle()
```
    Description copied from interface: IsDefaultOptions
    
    Returns the font style to use in the chart, on all objects, if not override by the specific configuration.
    
    Returns:
    
    Font style into chart.
  - getDefaultFontFamily
```
public final String getDefaultFontFamily()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getDefaultLineHeight
```
public final double getDefaultLineHeight()
```
    Description copied from interface: IsDefaultOptions
    
    Returns the height of an individual line of text.
    
    Returns:
    
    the height of an individual line of text.
  - isShowLines
```
public final boolean isShowLines()
```
    Description copied from interface: IsDefaultOptions
    
    If false, the lines between points are not drawn.
    
    Returns:
    
    If false, the lines between points are not drawn.
  - isSpanGaps
```
public final boolean isSpanGaps()
```
    Description copied from interface: IsDefaultOptions
    
    If false, NaN data causes a break in the line.
    
    Returns:
    
    If false, NaN data causes a break in the line.
  - getCutoutPercentage
```
public final double getCutoutPercentage()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - getRotation
```
public final double getRotation()
```
    Description copied from interface: IsDefaultOptions
    
    Returns the starting angle to draw arcs from.
    
    Returns:
    
    starting angle to draw arcs from.
  - getCircumference
```
public final double getCircumference()
```
    Description copied from interface: IsDefaultOptions
    
    Returns the the sweep to allow arcs to cover.
    
    Returns:
    
    the sweep to allow arcs to cover.
  - getStartAngle
```
public final double getStartAngle()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - isDrawOnAttach
```
public final boolean isDrawOnAttach()
```
    Description copied from interface: IsDefaultOptions
    
    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.
  - isDestroyOnDetach
```
public final boolean isDestroyOnDetach()
```
    Description copied from interface: IsDefaultOptions
    
    Returns true if the chart is configured to be destroyed on the attach of DIV element, otherwise false.
    
    Returns:
    
    the destroyOnDetach true if the chart is configured to be destroyed on the attach of DIV element, otherwise false. Default is true.

Class DefaultChartOptions

Constructor Summary

Method Summary

Methods inherited from class org.pepstock.charba.client.defaults.globals.AbstractDefaultOptions

Methods inherited from class java.lang.Object

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultOptions

Constructor Detail

DefaultChartOptions

DefaultChartOptions

Method Detail

getScale

getScales

isResponsive

getResponsiveAnimationDuration

isMaintainAspectRatio

getAspectRatio

getDevicePixelRatio

getDefaultColorAsString

getDefaultFontColorAsString

getDefaultFontSize

getDefaultFontStyle

getDefaultFontFamily

getDefaultLineHeight

isShowLines

isSpanGaps

getCutoutPercentage

getRotation

getCircumference

getStartAngle

isDrawOnAttach

isDestroyOnDetach