org.pepstock.charba.client.defaults.globals

Class DefaultOptions

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultOptions

All Implemented Interfaces:

IsDefaultOptions

Direct Known Subclasses:

DefaultScaledOptions

public class DefaultOptions
extends Object
implements IsDefaultOptions

CHART.JS default values for OPTIONS element. THIS IS THE ROOT OF ALL ELEMENTS DEFAULTS.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultOptions() Creates the object.

Method Summary

Modifier and Type	Method and Description
IsDefaultAnimation	getAnimation() Returns the animation defaults.
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	getDevicePixelRatio() The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g.
IsDefaultElements	getElements() Returns the elements defaults.
IsDefaultHover	getHover() Returns the hover defaults.
IsDefaultLayout	getLayout() Returns the layout defaults.
IsDefaultLegend	getLegend() Returns the legend defaults.
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.
IsDefaultTitle	getTitle() Returns the title defaults.
IsDefaultTooltips	getTooltips() Returns the tooltips defaults.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultOptions

protected DefaultOptions()

Creates the object. Protected to avoid any instantiation

Method Detail

getAnimation

public IsDefaultAnimation getAnimation()

Description copied from interface: IsDefaultOptions

Returns the animation defaults.

Specified by:

getAnimation in interface IsDefaultOptions

Returns:

the animation defaults.

getLayout

public IsDefaultLayout getLayout()

Description copied from interface: IsDefaultOptions

Returns the layout defaults.

Specified by:

getLayout in interface IsDefaultOptions

Returns:

the layout defaults.

getElements

public IsDefaultElements getElements()

Description copied from interface: IsDefaultOptions

Returns the elements defaults.

Specified by:

getElements in interface IsDefaultOptions

Returns:

the elements defaults.

getHover

public IsDefaultHover getHover()

Description copied from interface: IsDefaultOptions

Returns the hover defaults.

Specified by:

getHover in interface IsDefaultOptions

Returns:

the hover defaults.

getTitle

public IsDefaultTitle getTitle()

Description copied from interface: IsDefaultOptions

Returns the title defaults.

Specified by:

getTitle in interface IsDefaultOptions

Returns:

the title defaults.

getLegend

public IsDefaultLegend getLegend()

Description copied from interface: IsDefaultOptions

Returns the legend defaults.

Specified by:

getLegend in interface IsDefaultOptions

Returns:

the legend defaults.

getTooltips

public IsDefaultTooltips getTooltips()

Description copied from interface: IsDefaultOptions

Returns the tooltips defaults.

Specified by:

getTooltips in interface IsDefaultOptions

Returns:

the tooltips defaults.

isResponsive

public boolean isResponsive()

Description copied from interface: IsDefaultOptions

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.

getResponsiveAnimationDuration

public int getResponsiveAnimationDuration()

Description copied from interface: IsDefaultOptions

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.

isMaintainAspectRatio

public boolean isMaintainAspectRatio()

Description copied from interface: IsDefaultOptions

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.

getAspectRatio

public 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.

Specified by:

getAspectRatio in interface IsDefaultOptions

Returns:

the aspect ratio.

getDevicePixelRatio

public 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.

Specified by:

getDevicePixelRatio in interface IsDefaultOptions

Returns:

the pixel ratio.

getDefaultColorAsString

public 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.

Specified by:

getDefaultColorAsString in interface IsDefaultOptions

Returns:

color to use into chart.

getDefaultFontColorAsString

public 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.

Specified by:

getDefaultFontColorAsString in interface IsDefaultOptions

Returns:

font color to use into chart.

getDefaultFontSize

public 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.

Specified by:

getDefaultFontSize in interface IsDefaultOptions

Returns:

Font size into chart.

getDefaultFontStyle

public 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.

Specified by:

getDefaultFontStyle in interface IsDefaultOptions

Returns:

Font style into chart.

getDefaultFontFamily

public 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.

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.

isShowLines

public boolean isShowLines()

Description copied from interface: IsDefaultOptions

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.

isSpanGaps

public boolean isSpanGaps()

Description copied from interface: IsDefaultOptions

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.

getCutoutPercentage

public double getCutoutPercentage()

Description copied from interface: IsDefaultOptions

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.

getRotation

public double getRotation()

Description copied from interface: IsDefaultOptions

Returns the starting angle to draw arcs from.

Specified by:

getRotation in interface IsDefaultOptions

Returns:

starting angle to draw arcs from.

getCircumference

public double getCircumference()

Description copied from interface: IsDefaultOptions

Returns the the sweep to allow arcs to cover.

Specified by:

getCircumference in interface IsDefaultOptions

Returns:

the sweep to allow arcs to cover.

getStartAngle

public double getStartAngle()

Description copied from interface: IsDefaultOptions

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.