Interface IsDefaultOptions
-
- All Superinterfaces:
IsDefaultAnimationContainer
,IsDefaultAnimationTransition
,IsDefaultEventHandler
- All Known Subinterfaces:
IsDefaultScaledOptions
- All Known Implementing Classes:
AbstractDefaultOptions
,ChartOptions
,DefaultChartOptions
,DefaultGlobalOptions
,DefaultOptions
,DefaultScaledOptions
,ExtendedOptions
,GlobalOptions
,Options
,OptionsNode
,ScaledOptions
public interface IsDefaultOptions extends IsDefaultAnimationContainer, IsDefaultEventHandler
Interface to define options defaults.
THIS IS THE ROOT OF ALL INTERFACE DEFAULTS.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description double
getAspectRatio()
Canvas aspect ratio (i.e.String
getBackgroundColorAsString()
Returns the default background color to use in the chart, on all objects, if not override by the specific configuration.String
getBorderColorAsString()
Returns the default border color to use in the chart, on all objects, if not override by the specific configuration.double
getCircumference()
Returns the sweep to allow arcs to cover.String
getColorAsString()
Returns the default color to use in the chart, on all objects, if not override by the specific configuration.double
getCutout()
Returns the portion of the chart that is cut out of the middle.
AsDouble
, it is considered to be pixels.String
getCutoutPercentage()
Returns the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.IsDefaultDatasets
getDatasets()
Returns the plugins defaults.IsDefaultDecimation
getDecimation()
Returns the decimation defaults.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.IsDefaultFiller
getFiller()
Returns the filler defaults.IsDefaultFont
getFont()
Returns the font element.IsDefaultInteraction
getHover()
Returns the hover defaults.IndexAxis
getIndexAxis()
Returns the base axis for the dataset, only for bar options.IsDefaultInteraction
getInteraction()
Returns the interaction defaults.IsDefaultLayout
getLayout()
Returns the layout defaults.IsDefaultLegend
getLegend()
Returns the legend defaults.CLocale
getLocale()
Returns the locale instance for internationalization.IsDefaultPlugins
getPlugins()
Returns the plugins defaults.double
getRadius()
Returns the outer radius of the chart.
AsDouble
, it is considered to be pixels.String
getRadiusPercentage()
Returns the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.double
getResizeDelay()
Returns the delay the resize update by give amount of milliseconds.
This can ease the resize process by debouncing update of the elements.double
getRotation()
Returns the starting angle to draw arcs from.IsDefaultSubtitle
getSubtitle()
Returns the title defaults.IsDefaultTitle
getTitle()
Returns the title defaults.IsDefaultTooltips
getTooltips()
Returns the tooltips defaults.boolean
isDestroyOnDetach()
Returnstrue
if the chart is configured to be destroyed on the attach of DIV element, otherwisefalse
.boolean
isDrawOnAttach()
Returnstrue
if the chart is configured to be drawn on the attach of DIV element, otherwisefalse
.boolean
isMaintainAspectRatio()
Returns 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
isShowLine()
If false, the lines between points are not drawn.boolean
isSkipNull()
If true, null or undefined values will not be drawn.boolean
isSpanGaps()
If false,Double.NaN
data causes a break in the line.-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultAnimationContainer
getTransitions
-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultAnimationTransition
getAnimation, getAnimations
-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultEventHandler
getEvents
-
-
-
-
Method Detail
-
getHover
IsDefaultInteraction getHover()
Returns the hover defaults.- Returns:
- the hover defaults.
-
getInteraction
IsDefaultInteraction getInteraction()
Returns the interaction defaults.- Returns:
- the interaction defaults.
-
getTitle
IsDefaultTitle getTitle()
Returns the title defaults.- Returns:
- the title defaults.
-
getSubtitle
IsDefaultSubtitle getSubtitle()
Returns the title defaults.- Returns:
- the title defaults.
-
getLegend
IsDefaultLegend getLegend()
Returns the legend defaults.- Returns:
- the legend defaults.
-
getTooltips
IsDefaultTooltips getTooltips()
Returns the tooltips defaults.- Returns:
- the tooltips defaults.
-
getDecimation
IsDefaultDecimation getDecimation()
Returns the decimation defaults.- Returns:
- the decimation defaults.
-
getFiller
IsDefaultFiller getFiller()
Returns the filler defaults.- Returns:
- the filler defaults.
-
getLayout
IsDefaultLayout getLayout()
Returns the layout defaults.- Returns:
- the layout defaults.
-
getElements
IsDefaultElements getElements()
Returns the elements defaults.- Returns:
- the elements defaults.
-
getPlugins
IsDefaultPlugins getPlugins()
Returns the plugins defaults.- Returns:
- the plugins defaults.
-
getDatasets
IsDefaultDatasets getDatasets()
Returns the plugins defaults.- Returns:
- the plugins defaults.
-
getFont
IsDefaultFont getFont()
Returns the font element.- Returns:
- the font
-
getLocale
CLocale getLocale()
Returns the locale instance for internationalization.- Returns:
- the locale instance
-
isResponsive
boolean isResponsive()
Returns the resizing of the chart canvas when its container does.- Returns:
- the resizing of the chart canvas when its container does.
-
isMaintainAspectRatio
boolean isMaintainAspectRatio()
Returns 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
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.- Returns:
- the aspect ratio.
-
getResizeDelay
double getResizeDelay()
Returns 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
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.
-
getColorAsString
String getColorAsString()
Returns 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
String getBackgroundColorAsString()
Returns 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
String getBorderColorAsString()
Returns 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
boolean isShowLine()
If false, the lines between points are not drawn.- Returns:
- If false, the lines between points are not drawn.
-
isSkipNull
boolean isSkipNull()
If true, null or undefined values will not be drawn.- Returns:
- If true, null or undefined values will not be drawn.
-
isSpanGaps
boolean isSpanGaps()
If false,Double.NaN
data causes a break in the line.- Returns:
- If false,
Double.NaN
data causes a break in the line.
-
getCutout
double getCutout()
Returns 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
String getCutoutPercentage()
Returns the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.- Returns:
- the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.
-
getRadius
double getRadius()
Returns 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
String getRadiusPercentage()
Returns the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.- Returns:
- the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.
-
getRotation
double getRotation()
Returns the starting angle to draw arcs from.- Returns:
- starting angle to draw arcs from.
-
getCircumference
double getCircumference()
Returns the sweep to allow arcs to cover.- Returns:
- the sweep to allow arcs to cover.
-
getIndexAxis
IndexAxis getIndexAxis()
Returns the base axis for the dataset, only for bar options.- Returns:
- the base axis for the dataset, only for bar options
-
isDrawOnAttach
boolean isDrawOnAttach()
Returnstrue
if the chart is configured to be drawn on the attach of DIV element, otherwisefalse
.- Returns:
- the drawOnAttach
true
if the chart is configured to be drawn on the attach of DIV element, otherwisefalse
.
-
isDestroyOnDetach
boolean isDestroyOnDetach()
Returnstrue
if the chart is configured to be destroyed on the attach of DIV element, otherwisefalse
.- Returns:
- the destroyOnDetach
true
if the chart is configured to be destroyed on the attach of DIV element, otherwisefalse
.
-
-