Class Options
- java.lang.Object
-
- org.pepstock.charba.client.commons.NativeObjectContainer
-
- org.pepstock.charba.client.commons.AbstractNode
-
- org.pepstock.charba.client.options.AbstractModel<Options,IsDefaultOptions>
-
- org.pepstock.charba.client.options.Options
-
- All Implemented Interfaces:
HasCallbackScope
,IsDefaultAnimationContainer
,IsDefaultAnimationTransition
,IsDefaultEventHandler
,IsDefaultOptions
,HasAnimationOptions
,HasEvents
,HasSpanGaps
- Direct Known Subclasses:
GlobalOptions
,ScaledOptions
public class Options extends AbstractModel<Options,IsDefaultOptions> implements IsDefaultOptions, HasSpanGaps, HasAnimationOptions, HasCallbackScope, HasEvents
Base object which maps chart options.- Author:
- Andrea "Stock" Stocchero
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
Options.CommonProperty
Name of properties of native object.
Properties common with which extends this class.
-
Constructor Summary
Constructors Modifier Constructor Description protected
Options(String scope, IsDefaultOptions defaultValues)
Creates the object only with default provider.protected
Options(String scope, 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 Description Animation
getAnimation()
Returns the animation element.AnimationContainer
getAnimationContainer()
Returns an animation container instance to use in the default methods of this interface.double
getAspectRatio()
Canvas aspect ratio (i.e.IsColor
getBackgroundColor()
Returns the default background color to use in the chart, on all objects, if not override by the specific configuration.String
getBackgroundColorAsString()
Returns the default background color to use in the chart, on all objects, if not override by the specific configuration.IsColor
getBorderColor()
Returns the default border 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.String
getCharbaId()
Returns the CHARBA id when the options are related to a chart instance.double
getCircumference()
Returns the sweep to allow arcs to cover.IsColor
getColor()
Returns the default color to use in the chart, on all objects, if not override by the specific configuration.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.Datasets
getDatasets()
Returns the data sets element.Decimation
getDecimation()
Returns the decimation plugin element.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.EventsOptionHandler
getEventsOptionHandler()
Returns a event handler handler instance to use in the default methods of this interface.Filler
getFiller()
Returns the filler plugin element.Font
getFont()
Returns the font element.Hover
getHover()
Returns the hover element.IndexAxis
getIndexAxis()
Returns the base axis for the dataset, only for bar options.Interaction
getInteraction()
Returns the interaction element.Layout
getLayout()
Returns the layout element.Legend
getLegend()
Returns the legend element.CLocale
getLocale()
Returns the locale instance for internationalization.Plugins
getPlugins()
Returns the plugins element.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.String
getScope()
Returns the scope of the options, which is the options are used for defaults, chart defaults or chart.SpanGapHandler
getSpanGapHandler()
Returns a span gap handler instance to use in the default methods of this interface.Subtitle
getSubtitle()
Returns the title element.Title
getTitle()
Returns the title element.Tooltips
getTooltips()
Returns the tooltips element.boolean
isAutoColors()
Returnstrue
when the auto colors plugin has been enabled and CHART.JS apply the default colors to datasets.boolean
isAutoColorsForceOverride()
By default the colors plugin only works when you initialize the chart without any colors for the border or background specified.
If you want to force the colors plugin to always color your datasets, for example when using dynamic datasets at runtime you will need to set theforceOverride
option totrue
.boolean
isDestroyOnDetach()
Returnstrue
if the chart is configured to be destroyed on the detach from 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()
Iffalse
, the lines between points are not drawn.boolean
isSkipNull()
Iftrue
, null or undefined values will not be drawn.boolean
isSpanGaps()
If false,Double.NaN
data causes a break in the line.void
setAspectRatio(double ratio)
Canvas aspect ratio (i.e.void
setAutoColors(boolean enabled)
Setstrue
when the auto colors plugin has been enabled and CHART.JS apply the default colors to datasets.void
setAutoColorsForceOverride(boolean forceOverride)
By default the colors plugin only works when you initialize the chart without any colors for the border or background specified.
If you want to force the colors plugin to always color your datasets, for example when using dynamic datasets at runtime you will need to set theforceOverride
option totrue
.void
setBackgroundColor(String backgroundColor)
Sets the default background color to use in the chart, on all objects, if not override by the specific configuration.void
setBackgroundColor(IsColor backgroundColor)
Sets the default background color to use in the chart, on all objects, if not override by the specific configuration.void
setBorderColor(String borderColor)
Sets the default border color to use in the chart, on all objects, if not override by the specific configuration.void
setBorderColor(IsColor borderColor)
Sets the default border color to use in the chart, on all objects, if not override by the specific configuration.void
setCircumference(double circumference)
Sets the sweep to allow arcs to cover.void
setColor(String color)
Sets the default color to use in the chart, on all objects, if not override by the specific configuration.void
setColor(IsColor color)
Sets the default color to use in the chart, on all objects, if not override by the specific configuration.void
setCutout(double cutout)
Sets the portion of the chart that is cut out of the middle.
AsDouble
, it is considered to be pixels.void
setCutoutPercentage(String cutout)
Sets the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.void
setDestroyOnDetach(boolean destroyOnDetach)
Setstrue
if the chart is configured to be destroyed on the detach from DIV element, otherwisefalse
.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
setDrawOnAttach(boolean drawOnAttach)
Setstrue
if the chart is configured to be draw on the attach of DIV element, otherwisefalse
.void
setIndexAxis(IndexAxis indexAxis)
Sets the base axis for the dataset.void
setLocale(CLocale locale)
Sets the locale instance for internationalization.void
setMaintainAspectRatio(boolean maintainAspectRatio)
Sets the maintaining of the original canvas aspect ratio (width / height) when resizing.void
setRadius(double radius)
Sets the outer radius of the chart.
AsDouble
, it is considered to be pixels.void
setRadiusPercentage(String radius)
Sets the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.void
setResizeDelay(int delay)
Sets the delay the resize update by give amount of milliseconds.
This can ease the resize process by debouncing update of the elements.void
setResponsive(boolean responsive)
Sets the resizing of the chart canvas when its container does.void
setRotation(double rotation)
Sets the starting angle to draw arcs from.void
setShowLine(boolean showLine)
Iffalse
, the lines between points are not drawn.void
setSkipNull(boolean skipNull)
Iftrue
, null or undefined values will not be drawn.-
Methods inherited from class org.pepstock.charba.client.options.AbstractModel
getDefaultValues, getParent, loadPadding, setCallbackToModel, setCallbackToModel, setEventToModel
-
Methods inherited from class org.pepstock.charba.client.commons.AbstractNode
checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent
-
Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkAndGetColor, checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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
-
Methods inherited from interface org.pepstock.charba.client.options.HasAnimationOptions
getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled
-
Methods inherited from interface org.pepstock.charba.client.options.HasEvents
getEvents, setEvents, setEvents
-
Methods inherited from interface org.pepstock.charba.client.options.HasSpanGaps
getSpanGaps, setSpanGaps, setSpanGaps
-
-
-
-
Constructor Detail
-
Options
protected Options(String scope, 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:
scope
- scope of the optionsdefaultValues
- default provider instance.
-
Options
protected Options(String scope, IsDefaultOptions defaultValues, NativeObject nativeObject)
Creates the object only with default provider and native object. This is used as the root element.- Parameters:
scope
- scope of the optionsdefaultValues
- default provider instance.nativeObject
- native object to store properties.
-
-
Method Detail
-
getFont
public final Font getFont()
Returns the font element.- Specified by:
getFont
in interfaceIsDefaultOptions
- Returns:
- the font
-
getSpanGapHandler
public final SpanGapHandler getSpanGapHandler()
Description copied from interface:HasSpanGaps
Returns a span gap handler instance to use in the default methods of this interface.- Specified by:
getSpanGapHandler
in interfaceHasSpanGaps
- Returns:
- a span gap handler instance
-
getEventsOptionHandler
public final EventsOptionHandler getEventsOptionHandler()
Description copied from interface:HasEvents
Returns a event handler handler instance to use in the default methods of this interface.- Specified by:
getEventsOptionHandler
in interfaceHasEvents
- Returns:
- a event handler handler instance
-
getScope
public final String getScope()
Returns the scope of the options, which is the options are used for defaults, chart defaults or chart.- Specified by:
getScope
in interfaceHasCallbackScope
- Returns:
- the scope of the options
-
getAnimation
public Animation getAnimation()
Returns the animation element.- Specified by:
getAnimation
in interfaceHasAnimationOptions
- Specified by:
getAnimation
in interfaceIsDefaultAnimationTransition
- Returns:
- the animation
-
getAnimationContainer
public final AnimationContainer getAnimationContainer()
Description copied from interface:HasAnimationOptions
Returns an animation container instance to use in the default methods of this interface.- Specified by:
getAnimationContainer
in interfaceHasAnimationOptions
- Returns:
- an animation container instance
-
getLegend
public Legend getLegend()
Returns the legend element.- Specified by:
getLegend
in interfaceIsDefaultOptions
- Returns:
- the legend
-
getHover
public final Hover getHover()
Returns the hover element.- Specified by:
getHover
in interfaceIsDefaultOptions
- Returns:
- the hover
-
getInteraction
public final Interaction getInteraction()
Returns the interaction element.- Specified by:
getInteraction
in interfaceIsDefaultOptions
- Returns:
- the interaction
-
getLayout
public final Layout getLayout()
Returns the layout element.- Specified by:
getLayout
in interfaceIsDefaultOptions
- Returns:
- the layout
-
getDecimation
public final Decimation getDecimation()
Returns the decimation plugin element.- Specified by:
getDecimation
in interfaceIsDefaultOptions
- Returns:
- the decimation plugin element
-
getFiller
public final Filler getFiller()
Returns the filler plugin element.- Specified by:
getFiller
in interfaceIsDefaultOptions
- Returns:
- the filler plugin element
-
getElements
public final Elements getElements()
Returns the elements element.- Specified by:
getElements
in interfaceIsDefaultOptions
- Returns:
- the elements
-
getTitle
public final Title getTitle()
Returns the title element.- Specified by:
getTitle
in interfaceIsDefaultOptions
- Returns:
- the title
-
getSubtitle
public final Subtitle getSubtitle()
Returns the title element.- Specified by:
getSubtitle
in interfaceIsDefaultOptions
- Returns:
- the title
-
getTooltips
public final Tooltips getTooltips()
Returns the tooltips element.- Specified by:
getTooltips
in interfaceIsDefaultOptions
- Returns:
- the tooltips
-
getPlugins
public Plugins getPlugins()
Returns the plugins element.- Specified by:
getPlugins
in interfaceIsDefaultOptions
- Returns:
- the plugins
-
getDatasets
public Datasets getDatasets()
Returns the data sets element.- Specified by:
getDatasets
in interfaceIsDefaultOptions
- Returns:
- the data sets element
-
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
Undefined.STRING
.
-
setLocale
public void setLocale(CLocale locale)
Sets the locale instance for internationalization.- Parameters:
locale
- the locale instance
-
getLocale
public CLocale getLocale()
Returns the locale instance for internationalization.- Specified by:
getLocale
in interfaceIsDefaultOptions
- Returns:
- the locale instance
-
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 interfaceIsDefaultOptions
- Returns:
- the resizing of the chart canvas when its container does.
-
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 maintaining of the original canvas aspect ratio (width / height) when resizing.- Specified by:
isMaintainAspectRatio
in interfaceIsDefaultOptions
- 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 interfaceIsDefaultOptions
- Returns:
- the aspect ratio.
-
setResizeDelay
public void setResizeDelay(int delay)
Sets the delay the resize update by give amount of milliseconds.
This can ease the resize process by debouncing update of the elements.- Parameters:
delay
- the delay the resize update by give amount of milliseconds
-
getResizeDelay
public 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.- Specified by:
getResizeDelay
in interfaceIsDefaultOptions
- Returns:
- the delay the resize update by give amount of milliseconds
-
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 interfaceIsDefaultOptions
- Returns:
- the pixel ratio.
-
isDrawOnAttach
public boolean isDrawOnAttach()
Returnstrue
if the chart is configured to be drawn on the attach of DIV element, otherwisefalse
.- Specified by:
isDrawOnAttach
in interfaceIsDefaultOptions
- Returns:
- the drawOnAttach
true
if the chart is configured to be drawn on the attach of DIV element, otherwisefalse
.
-
setDrawOnAttach
public void setDrawOnAttach(boolean drawOnAttach)
Setstrue
if the chart is configured to be draw on the attach of DIV element, otherwisefalse
.- Parameters:
drawOnAttach
- the drawOnAttach to set
-
isDestroyOnDetach
public boolean isDestroyOnDetach()
Returnstrue
if the chart is configured to be destroyed on the detach from DIV element, otherwisefalse
.- Specified by:
isDestroyOnDetach
in interfaceIsDefaultOptions
- Returns:
- the destroyOnDetach
true
if the chart is configured to be destroyed on the attach of DIV element, otherwisefalse
.
-
setDestroyOnDetach
public void setDestroyOnDetach(boolean destroyOnDetach)
Setstrue
if the chart is configured to be destroyed on the detach from DIV element, otherwisefalse
.- Parameters:
destroyOnDetach
- the destroyOnDetach to set
-
setColor
public void setColor(IsColor color)
Sets the default color to use in the chart, on all objects, if not override by the specific configuration.- Parameters:
color
- color to use in the chart.
-
setColor
public void setColor(String color)
Sets the default color to use in the chart, on all objects, if not override by the specific configuration.- Parameters:
color
- color to use in the chart.
-
getColorAsString
public String getColorAsString()
Returns the default color to use in the chart, on all objects, if not override by the specific configuration.- Specified by:
getColorAsString
in interfaceIsDefaultOptions
- Returns:
- color to use in the chart.
-
getColor
public IsColor getColor()
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.
-
setBackgroundColor
public void setBackgroundColor(IsColor backgroundColor)
Sets the default background color to use in the chart, on all objects, if not override by the specific configuration.- Parameters:
backgroundColor
- background color to use in the chart.
-
setBackgroundColor
public void setBackgroundColor(String backgroundColor)
Sets the default background color to use in the chart, on all objects, if not override by the specific configuration.- Parameters:
backgroundColor
- background color to use in the chart.
-
getBackgroundColorAsString
public String getBackgroundColorAsString()
Returns the default background color to use in the chart, on all objects, if not override by the specific configuration.- Specified by:
getBackgroundColorAsString
in interfaceIsDefaultOptions
- Returns:
- background color to use in the chart.
-
getBackgroundColor
public IsColor getBackgroundColor()
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.
-
setBorderColor
public void setBorderColor(IsColor borderColor)
Sets the default border color to use in the chart, on all objects, if not override by the specific configuration.- Parameters:
borderColor
- border color to use in the chart.
-
setBorderColor
public void setBorderColor(String borderColor)
Sets the default border color to use in the chart, on all objects, if not override by the specific configuration.- Parameters:
borderColor
- border color to use in the chart.
-
getBorderColorAsString
public String getBorderColorAsString()
Returns the default border color to use in the chart, on all objects, if not override by the specific configuration.- Specified by:
getBorderColorAsString
in interfaceIsDefaultOptions
- Returns:
- border color to use in the chart.
-
getBorderColor
public IsColor getBorderColor()
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.
-
setAutoColors
public void setAutoColors(boolean enabled)
Setstrue
when the auto colors plugin has been enabled and CHART.JS apply the default colors to datasets.- Parameters:
enabled
-true
when the auto colors plugin has been enabled and CHART.JS apply the default colors to datasets
-
isAutoColors
public boolean isAutoColors()
Returnstrue
when the auto colors plugin has been enabled and CHART.JS apply the default colors to datasets.- Specified by:
isAutoColors
in interfaceIsDefaultOptions
- Returns:
true
when the auto colors plugin has been enabled and CHART.JS apply the default colors to datasets
-
setAutoColorsForceOverride
public void setAutoColorsForceOverride(boolean forceOverride)
By default the colors plugin only works when you initialize the chart without any colors for the border or background specified.
If you want to force the colors plugin to always color your datasets, for example when using dynamic datasets at runtime you will need to set theforceOverride
option totrue
.- Parameters:
forceOverride
-true
if auto color plugin forces setting palette.
-
isAutoColorsForceOverride
public boolean isAutoColorsForceOverride()
By default the colors plugin only works when you initialize the chart without any colors for the border or background specified.
If you want to force the colors plugin to always color your datasets, for example when using dynamic datasets at runtime you will need to set theforceOverride
option totrue
.- Specified by:
isAutoColorsForceOverride
in interfaceIsDefaultOptions
- Returns:
true
if auto color plugin forces setting palette.
-
setShowLine
public void setShowLine(boolean showLine)
Iffalse
, the lines between points are not drawn.- Parameters:
showLine
- iffalse
, the lines between points are not drawn.
-
isShowLine
public boolean isShowLine()
Iffalse
, the lines between points are not drawn.- Specified by:
isShowLine
in interfaceIsDefaultOptions
- Returns:
- if
false
, the lines between points are not drawn.
-
setSkipNull
public void setSkipNull(boolean skipNull)
Iftrue
, null or undefined values will not be drawn.- Parameters:
skipNull
- iftrue
, null or undefined values will not be drawn
-
isSkipNull
public boolean isSkipNull()
Iftrue
, null or undefined values will not be drawn.- Specified by:
isSkipNull
in interfaceIsDefaultOptions
- Returns:
- If
true
, null or undefined values will not be drawn
-
setCutout
public void setCutout(double cutout)
Sets the portion of the chart that is cut out of the middle.
AsDouble
, it is considered to be pixels.- Parameters:
cutout
- the portion of the chart that is cut out of the middle.
AsDouble
, it is considered to be pixels.
-
getCutout
public double getCutout()
Returns the portion of the chart that is cut out of the middle.
AsDouble
, it is considered to be pixels.- Specified by:
getCutout
in interfaceIsDefaultOptions
- Returns:
- the portion of the chart that is cut out of the middle.
AsDouble
, it is considered to be pixels.
-
setCutoutPercentage
public void setCutoutPercentage(String cutout)
Sets the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.- Parameters:
cutout
- the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.
-
getCutoutPercentage
public String getCutoutPercentage()
Returns the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.- Specified by:
getCutoutPercentage
in interfaceIsDefaultOptions
- Returns:
- the portion of the chart that is cut out of the middle.
AsString
and ending with '%', percentage of the chart radius.
-
setRadius
public void setRadius(double radius)
Sets the outer radius of the chart.
AsDouble
, it is considered to be pixels.- Parameters:
radius
- the outer radius of the chart.
AsDouble
, it is considered to be pixels.
-
getRadius
public double getRadius()
Returns the outer radius of the chart.
AsDouble
, it is considered to be pixels.- Specified by:
getRadius
in interfaceIsDefaultOptions
- Returns:
- the outer radius of the chart.
AsDouble
, it is considered to be pixels.
-
setRadiusPercentage
public void setRadiusPercentage(String radius)
Sets the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.- Parameters:
radius
- the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.
-
getRadiusPercentage
public String getRadiusPercentage()
Returns the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.- Specified by:
getRadiusPercentage
in interfaceIsDefaultOptions
- Returns:
- the outer radius of the chart.
AsString
and ending with '%', percentage of the maximum radius.
-
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 interfaceIsDefaultOptions
- 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 sweep to allow arcs to cover.- Specified by:
getCircumference
in interfaceIsDefaultOptions
- Returns:
- the sweep to allow arcs to cover.
-
setIndexAxis
public void setIndexAxis(IndexAxis indexAxis)
Sets the base axis for the dataset. UseIndexAxis.Y
for horizontal bar.- Parameters:
indexAxis
- the base axis for the dataset
-
getIndexAxis
public IndexAxis getIndexAxis()
Returns the base axis for the dataset, only for bar options.- Specified by:
getIndexAxis
in interfaceIsDefaultOptions
- Returns:
- the base axis for the dataset, only for bar options
-
isSpanGaps
public boolean isSpanGaps()
Description copied from interface:IsDefaultOptions
If false,Double.NaN
data causes a break in the line.- Specified by:
isSpanGaps
in interfaceHasSpanGaps
- Specified by:
isSpanGaps
in interfaceIsDefaultOptions
- Returns:
- If false,
Double.NaN
data causes a break in the line.
-
-