Class RadialAxis
- java.lang.Object
-
- org.pepstock.charba.client.configuration.Axis
-
- org.pepstock.charba.client.configuration.RadialAxis
-
- All Implemented Interfaces:
IsLinearAxis
,IsNumericAxis
public class RadialAxis extends Axis implements IsLinearAxis
Radial axes are used specifically for the radar and polar area chart types.
These axes overlay the chart area, rather than being positioned on one of the edges.
The linear scale is use to chart numerical data.
As the name suggests, linear interpolation is used to determine where a value lies in relation the center of the axis.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Modifier Constructor Description RadialAxis(IsChart chart)
Builds the object storing the chart instance.protected
RadialAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind)
Builds the object storing the chart instance and cartesian axis type.
-
Method Summary
All Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method Description RadialAngleLines
getAngleLines()
Returns the angle lines element.Axis
getAxisElement()
Returns the axis instance.org.pepstock.charba.client.configuration.BegiAtZeroCallbackHandler
getBegiAtZeroCallbackHandler()
default BeginAtZeroCallback
getBeginAtZeroCallback()
Returns the callback to set if true, scale will include 0 if it is not already included.AxisBorder
getBorder()
Returns the border element.IsChart
getChart()
Returns the chart instanceprotected T
getConfiguration()
Returns the configuration element.Grid
getGrid()
Returns the grid element.default MinMaxCallback<T>
getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.default MinMaxCallback<T>
getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.org.pepstock.charba.client.configuration.MinMaxCallbacksHandler<Double>
getMinMaxCallbacksHandler()
RadialPointLabels
getPointLabels()
Returns the point labels element.double
getStartAngle()
Returns the starting angle to draw arcs for the first item in a data set.StartAngleCallback
getStartAngleCallback()
Returns the user callback that sets the starting angle to draw arcs for the first item in a data set.default MinMaxCallback<T>
getSuggestedMaxCallback()
Returns the callback to set the adjustment used when calculating the maximum data value.default MinMaxCallback<T>
getSuggestedMinCallback()
Returns the callback to set the adjustment used when calculating the minimum data value.RadialLinearTick
getTicks()
Returns the ticks element.boolean
isAnimate()
Returns whether to animate scaling the chart from the center.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
setAnimate(boolean animate)
Sets whether to animate scaling the chart from the center.default void
setBeginAtZero(BeginAtZeroCallback beginAtZeroCallback)
Sets the callback to set if true, scale will include 0 if it is not already included.default void
setBeginAtZero(NativeCallback beginAtZeroCallback)
Sets the callback to set if true, scale will include 0 if it is not already included.protected void
setConfiguration(T configuration)
default void
setMax(MinMaxCallback<T> maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.default void
setMax(NativeCallback maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.default void
setMin(MinMaxCallback<T> minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.default void
setMin(NativeCallback minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.void
setStartAngle(double startAngle)
Sets the starting angle to draw arcs for the first item in a data set.void
setStartAngle(NativeCallback startAngleCallback)
Sets the user callback that sets the starting angle to draw arcs for the first item in a data set.void
setStartAngle(StartAngleCallback startAngleCallback)
Sets the user callback that sets the starting angle to draw arcs for the first item in a data set.default void
setSuggestedMax(MinMaxCallback<T> suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.default void
setSuggestedMax(NativeCallback suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.default void
setSuggestedMin(MinMaxCallback<T> suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.default void
setSuggestedMin(NativeCallback suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.String
toJSON()
Returns the JSON representation of the object.-
Methods inherited from class org.pepstock.charba.client.configuration.Axis
getAlignToPixelsCallback, getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getBackgroundColorCallback, getCharbaId, getDisplay, getDisplayCallback, getId, getReverseCallback, getScaleItem, getType, getWeight, getWeightCallback, isAlignToPixels, isReverse, setAlignToPixels, setAlignToPixels, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setDisplay, setDisplay, setReverse, setReverse, setReverse, setWeight, setWeight, setWeight
-
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.IsLinearAxis
isBeginAtZero, setBeginAtZero
-
Methods inherited from interface org.pepstock.charba.client.configuration.IsNumericAxis
getMax, getMin, getSuggestedMax, getSuggestedMin, setMax, setMin, setSuggestedMax, setSuggestedMin
-
-
-
-
Constructor Detail
-
RadialAxis
public RadialAxis(IsChart chart)
Builds the object storing the chart instance.- Parameters:
chart
- chart instance
-
-
Method Detail
-
getAxisElement
public Axis getAxisElement()
Description copied from interface:IsNumericAxis
Returns the axis instance.- Specified by:
getAxisElement
in interfaceIsNumericAxis
- Returns:
- the axis
-
getMinMaxCallbacksHandler
public org.pepstock.charba.client.configuration.MinMaxCallbacksHandler<Double> getMinMaxCallbacksHandler()
-
getBegiAtZeroCallbackHandler
public org.pepstock.charba.client.configuration.BegiAtZeroCallbackHandler getBegiAtZeroCallbackHandler()
-
getTicks
public RadialLinearTick getTicks()
Returns the ticks element.- Returns:
- the ticks
-
getBorder
public AxisBorder getBorder()
Returns the border element.- Returns:
- the border
-
getGrid
public Grid getGrid()
Returns the grid element.- Returns:
- the grid
-
getAngleLines
public RadialAngleLines getAngleLines()
Returns the angle lines element.- Returns:
- the angleLines
-
getPointLabels
public RadialPointLabels getPointLabels()
Returns the point labels element.- Returns:
- the pointLabels
-
setAnimate
public void setAnimate(boolean animate)
Sets whether to animate scaling the chart from the center.- Parameters:
animate
- whether to animate scaling the chart from the center.
-
isAnimate
public boolean isAnimate()
Returns whether to animate scaling the chart from the center.- Returns:
- whether to animate scaling the chart from the center.
-
setStartAngle
public void setStartAngle(double startAngle)
Sets the starting angle to draw arcs for the first item in a data set.- Parameters:
startAngle
- starting angle to draw arcs for the first item in a data set.
-
getStartAngle
public double getStartAngle()
Returns the starting angle to draw arcs for the first item in a data set.- Returns:
- starting angle to draw arcs for the first item in a data set.
-
getStartAngleCallback
public StartAngleCallback getStartAngleCallback()
Returns the user callback that sets the starting angle to draw arcs for the first item in a data set.- Returns:
- the user callback that sets the starting angle to draw arcs for the first item in a data set.
-
setStartAngle
public void setStartAngle(StartAngleCallback startAngleCallback)
Sets the user callback that sets the starting angle to draw arcs for the first item in a data set.- Parameters:
startAngleCallback
- the user callback that sets the starting angle to draw arcs for the first item in a data set.
-
setStartAngle
public void setStartAngle(NativeCallback startAngleCallback)
Sets the user callback that sets the starting angle to draw arcs for the first item in a data set.- Parameters:
startAngleCallback
- that sets the starting angle to draw arcs for the first item in a data set.
-
getMinCallback
public default MinMaxCallback<T> getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Returns:
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMin
public default void setMin(MinMaxCallback<T> minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Parameters:
minCallback
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMin
public default void setMin(NativeCallback minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Parameters:
minCallback
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMax
public default void setMax(MinMaxCallback<T> maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Parameters:
maxCallback
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
setMax
public default void setMax(NativeCallback maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Parameters:
maxCallback
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
getMaxCallback
public default MinMaxCallback<T> getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Returns:
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
getSuggestedMinCallback
public default MinMaxCallback<T> getSuggestedMinCallback()
Returns the callback to set the adjustment used when calculating the minimum data value.- Returns:
- the callback to set the adjustment used when calculating the minimum data value.
-
setSuggestedMin
public default void setSuggestedMin(MinMaxCallback<T> suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.- Parameters:
suggestedMinCallback
- the callback to set the adjustment used when calculating the minimum data value.
-
setSuggestedMin
public default void setSuggestedMin(NativeCallback suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.- Parameters:
suggestedMinCallback
- the callback to set the adjustment used when calculating the minimum data value.
-
getSuggestedMaxCallback
public default MinMaxCallback<T> getSuggestedMaxCallback()
Returns the callback to set the adjustment used when calculating the maximum data value.- Returns:
- the callback to set the adjustment used when calculating the maximum data value.
-
setSuggestedMax
public default void setSuggestedMax(MinMaxCallback<T> suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.- Parameters:
suggestedMaxCallback
- the callback to set the adjustment used when calculating the maximum data value.
-
setSuggestedMax
public default void setSuggestedMax(NativeCallback suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.- Parameters:
suggestedMaxCallback
- the callback to set the adjustment used when calculating the maximum data value.
-
getBeginAtZeroCallback
public default BeginAtZeroCallback getBeginAtZeroCallback()
Returns the callback to set if true, scale will include 0 if it is not already included.- Returns:
- the callback to set if true, scale will include 0 if it is not already included.
-
setBeginAtZero
public default void setBeginAtZero(BeginAtZeroCallback beginAtZeroCallback)
Sets the callback to set if true, scale will include 0 if it is not already included.- Parameters:
beginAtZeroCallback
- the callback to set if true, scale will include 0 if it is not already included.
-
setBeginAtZero
public default void setBeginAtZero(NativeCallback beginAtZeroCallback)
Sets the callback to set if true, scale will include 0 if it is not already included.- Parameters:
beginAtZeroCallback
- the callback to set if true, scale will include 0 if it is not already included.
-
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
-
-