Class AbstractPieOptions
- java.lang.Object
-
- org.pepstock.charba.client.configuration.ConfigurationOptions
-
- org.pepstock.charba.client.configuration.AbstractPieOptions
-
- All Implemented Interfaces:
HasAnimation
,ConfigurationElement
,AddHandlerEventHandler
,EventHandler
,RemoveHandlerEventHandler
- Direct Known Subclasses:
DoughnutOptions
,MeterOptions
,PieOptions
public abstract class AbstractPieOptions extends ConfigurationOptions
Abstract options for PIE chart. It contains all properties for this kind of chart.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractPieOptions(IsChart chart, IsDefaultScaledOptions defaultvalues)
Builds the object storing the chart instance and defaults.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Axis
getAxisById(int id)
Returns the axis by the unique CHARBA id of scale ornull
if not axis.IsChart
getChart()
Returns the chart instancedouble
getCircumference()
Returns the sweep to allow arcs to cover.protected T
getConfiguration()
Returns the configuration element.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.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
getRotation()
Returns the starting angle to draw arcs from.ChartEnvelop<NativeObject>
loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.pepstock.charba.client
package.void
merge(NativeObjectContainer source, String property)
Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.void
setCircumference(double circumference)
Sets the sweep to allow arcs to cover.protected void
setConfiguration(T 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
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
setRotation(double rotation)
Sets the starting angle to draw arcs from.String
toJSON()
Returns the JSON representation of the object.-
Methods inherited from class org.pepstock.charba.client.configuration.ConfigurationOptions
afterAxisConfigurationUpdate, afterConfigurationUpdate, beforeAxisConfigurationUpdate, beforeConfigurationUpdate, getAnimationContainer, getAspectRatio, getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getColor, getColorAsString, getDatasets, getDevicePixelRatio, getElements, getEvents, getFiller, getFont, getHover, getInteraction, getLayout, getLegend, getLocale, getPlugins, getResizeDelay, getSubtitle, getTitle, getTooltips, hasAxisClickHandlers, hasAxisEnterHandlers, hasAxisHoverHandlers, hasAxisLeaveHandlers, hasDatasetSelectionHandlers, hasSubtitleClickHandlers, hasSubtitleEnterHandlers, hasSubtitleLeaveHandlers, hasTitleClickHandlers, hasTitleEnterHandlers, hasTitleLeaveHandlers, isAutoColors, isAutoColorsForceOverride, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, load, loadOptions, onAdd, onRemove, setAspectRatio, setAutoColors, setAutoColorsForceOverride, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setChartOptions, setColor, setColor, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setEvents, setLocale, setMaintainAspectRatio, setResizeDelay, setResponsive
-
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.configuration.HasAnimation
getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled
-
-
-
-
Constructor Detail
-
AbstractPieOptions
protected AbstractPieOptions(IsChart chart, IsDefaultScaledOptions defaultvalues)
Builds the object storing the chart instance and defaults.- Parameters:
chart
- chart instancedefaultvalues
- defaults of chart
-
-
Method Detail
-
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.
-
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.
-
getCutout
public 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
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.- 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.- 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.- 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.- 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.- Returns:
- the sweep to allow arcs to cover.
-
getAxisById
protected final Axis getAxisById(int id)
Description copied from class:ConfigurationOptions
Returns the axis by the unique CHARBA id of scale ornull
if not axis.- Overrides:
getAxisById
in classConfigurationOptions
- Parameters:
id
- the unique CHARBA id of scale- Returns:
- the axis or
null
if not axis.
-
setConfiguration
protected final void setConfiguration(T configuration)
- Parameters:
configuration
- the configuration to set
-
getConfiguration
protected final T getConfiguration()
Returns the configuration element.- Returns:
- the configuration element.
-
merge
public final void merge(NativeObjectContainer source, String property)
Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.- Parameters:
source
- native object container to addproperty
- property name
-
toJSON
public final String toJSON()
Returns the JSON representation of the object.- Returns:
- the JSON representation of the object.
-
loadNativeObject
public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.pepstock.charba.client
package.- Parameters:
envelop
- envelop instance which will contain the native object- Returns:
- the envelop, passed as argument, loaded with the native object
-
getChart
public final IsChart getChart()
Returns the chart instance- Returns:
- the chart
-
-