Class DefaultOptions
- java.lang.Object
-
- org.pepstock.charba.client.defaults.globals.AbstractDefaultOptions
-
- org.pepstock.charba.client.defaults.globals.DefaultOptions
-
- All Implemented Interfaces:
IsDefaultAnimationContainer,IsDefaultAnimationTransition,IsDefaultOptions
- Direct Known Subclasses:
DefaultScaledOptions
public class DefaultOptions extends AbstractDefaultOptions
CHART.JS default values for OPTIONS element. THIS IS THE ROOT OF ALL ELEMENTS DEFAULTS.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description doublegetAspectRatio()Canvas aspect ratio (i.e.StringgetBackgroundColorAsString()Returns the default background color to use in the chart, on all objects, if not override by the specific configuration.StringgetBorderColorAsString()Returns the default border color to use in the chart, on all objects, if not override by the specific configuration.doublegetCircumference()Returns the sweep to allow arcs to cover.StringgetColorAsString()Returns the default color to use in the chart, on all objects, if not override by the specific configuration.doublegetCutout()Returns the portion of the chart that is cut out of the middle.
AsDouble, it is considered to be pixels.StringgetCutoutPercentage()Returns the portion of the chart that is cut out of the middle.
AsStringand ending with '%', percentage of the chart radius.doublegetDevicePixelRatio()The chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g.Set<Event>getEvents()Returns the browser events that the chart should listen to.IndexAxisgetIndexAxis()Returns the base axis for the dataset, only for bar options.CLocalegetLocale()Returns the locale instance for internationalization.doublegetRadius()Returns the outer radius of the chart.
AsDouble, it is considered to be pixels.StringgetRadiusPercentage()Returns the outer radius of the chart.
AsStringand ending with '%', percentage of the maximum radius.doublegetResizeDelay()Returns the delay the resize update by give amount of milliseconds.
This can ease the resize process by debouncing update of the elements.doublegetRotation()Returns the starting angle to draw arcs from.booleanisDestroyOnDetach()Returnstrueif the chart is configured to be destroyed on the attach of DIV element, otherwisefalse.booleanisDrawOnAttach()Returnstrueif the chart is configured to be drawn on the attach of DIV element, otherwisefalse.booleanisMaintainAspectRatio()Returns the maintaining of the original canvas aspect ratio (width / height) when resizing.booleanisResponsive()Returns the resizing of the chart canvas when its container does.booleanisShowLine()If false, the lines between points are not drawn.booleanisSkipNull()If true, null or undefined values will not be drawn.booleanisSpanGaps()If false,Double.NaNdata causes a break in the line.-
Methods inherited from class org.pepstock.charba.client.defaults.globals.AbstractDefaultOptions
getAnimation, getAnimations, getDatasets, getDecimation, getElements, getFiller, getFont, getHover, getInteraction, getLayout, getLegend, getPlugins, getSubtitle, getTitle, getTooltips, getTransitions
-
-
-
-
Method Detail
-
getEvents
public Set<Event> getEvents()
Description copied from interface:IsDefaultOptionsReturns the browser events that the chart should listen to.- Returns:
- the browser events that the chart should listen to.
-
getLocale
public CLocale getLocale()
Description copied from interface:IsDefaultOptionsReturns the locale instance for internationalization.- Returns:
- the locale instance
-
isResponsive
public boolean isResponsive()
Description copied from interface:IsDefaultOptionsReturns the resizing of the chart canvas when its container does.- Returns:
- the resizing of the chart canvas when its container does.
-
isMaintainAspectRatio
public boolean isMaintainAspectRatio()
Description copied from interface:IsDefaultOptionsReturns 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 double getAspectRatio()
Description copied from interface:IsDefaultOptionsCanvas 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.
-
getResizeDelay
public double getResizeDelay()
Description copied from interface:IsDefaultOptionsReturns the delay the resize update by give amount of milliseconds.
This can ease the resize process by debouncing update of the elements.- Returns:
- the delay the resize update by give amount of milliseconds
-
getDevicePixelRatio
public double getDevicePixelRatio()
Description copied from interface:IsDefaultOptionsThe 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.
-
getColorAsString
public String getColorAsString()
Description copied from interface:IsDefaultOptionsReturns the default color to use in the chart, on all objects, if not override by the specific configuration.- Returns:
- color to use in the chart.
-
getBackgroundColorAsString
public String getBackgroundColorAsString()
Description copied from interface:IsDefaultOptionsReturns the default background color to use in the chart, on all objects, if not override by the specific configuration.- Returns:
- background color to use in the chart.
-
getBorderColorAsString
public String getBorderColorAsString()
Description copied from interface:IsDefaultOptionsReturns the default border color to use in the chart, on all objects, if not override by the specific configuration.- Returns:
- border color to use in the chart.
-
isShowLine
public boolean isShowLine()
Description copied from interface:IsDefaultOptionsIf false, the lines between points are not drawn.- Returns:
- If false, the lines between points are not drawn.
-
isSpanGaps
public boolean isSpanGaps()
Description copied from interface:IsDefaultOptionsIf false,Double.NaNdata causes a break in the line.- Returns:
- If false,
Double.NaNdata causes a break in the line.
-
getCutout
public double getCutout()
Description copied from interface:IsDefaultOptionsReturns the portion of the chart that is cut out of the middle.
AsDouble, it is considered to be pixels.- Returns:
- the portion of the chart that is cut out of the middle.
AsDouble, it is considered to be pixels.
-
getCutoutPercentage
public String getCutoutPercentage()
Description copied from interface:IsDefaultOptionsReturns the portion of the chart that is cut out of the middle.
AsStringand ending with '%', percentage of the chart radius.- Returns:
- the portion of the chart that is cut out of the middle.
AsStringand ending with '%', percentage of the chart radius.
-
getRadius
public double getRadius()
Description copied from interface:IsDefaultOptionsReturns the outer radius of the chart.
AsDouble, it is considered to be pixels.- Returns:
- the outer radius of the chart.
AsDouble, it is considered to be pixels.
-
getRadiusPercentage
public String getRadiusPercentage()
Description copied from interface:IsDefaultOptionsReturns the outer radius of the chart.
AsStringand ending with '%', percentage of the maximum radius.- Returns:
- the outer radius of the chart.
AsStringand ending with '%', percentage of the maximum radius.
-
getRotation
public double getRotation()
Description copied from interface:IsDefaultOptionsReturns the starting angle to draw arcs from.- Returns:
- starting angle to draw arcs from.
-
getCircumference
public double getCircumference()
Description copied from interface:IsDefaultOptionsReturns the sweep to allow arcs to cover.- Returns:
- the sweep to allow arcs to cover.
-
isDrawOnAttach
public boolean isDrawOnAttach()
Description copied from interface:IsDefaultOptionsReturnstrueif the chart is configured to be drawn on the attach of DIV element, otherwisefalse.- Returns:
- the drawOnAttach
trueif the chart is configured to be drawn on the attach of DIV element, otherwisefalse.
-
isDestroyOnDetach
public boolean isDestroyOnDetach()
Description copied from interface:IsDefaultOptionsReturnstrueif the chart is configured to be destroyed on the attach of DIV element, otherwisefalse.- Returns:
- the destroyOnDetach
trueif the chart is configured to be destroyed on the attach of DIV element, otherwisefalse.
-
isSkipNull
public boolean isSkipNull()
Description copied from interface:IsDefaultOptionsIf true, null or undefined values will not be drawn.- Returns:
- If true, null or undefined values will not be drawn.
-
getIndexAxis
public IndexAxis getIndexAxis()
Description copied from interface:IsDefaultOptionsReturns the base axis for the dataset, only for bar options.- Returns:
- the base axis for the dataset, only for bar options
-
-