Package org.pepstock.charba.client.configuration

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

Modifier and Type	Method	Description
RadialAngleLines	getAngleLines()	Returns the angle lines element.
Axis	getAxisElement()	Returns the axis instance.
IsChart	getChart()	Returns the chart instance
protected T	getConfiguration()	Returns the configuration element.
Grid	getGrid()	Returns the grid element.
RadialPointLabels	getPointLabels()	Returns the point labels element.
double	getStartAngle()	Returns the starting angle to draw arcs for the first item in a data set.
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 from org.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.
protected void	setConfiguration(T configuration)
void	setStartAngle(double startAngle)	Sets the starting angle to draw arcs for the first item in a data set.
String	toJSON()	Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.Axis

getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getCharbaId, getDisplay, getId, getType, getWeight, isAlignToPixels, isReverse, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setReverse, 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

RadialAxis

protected RadialAxis(IsChart chart,
                     ScaleId id,
                     AxisType type,
                     AxisKind kind)

Builds the object storing the chart instance and cartesian axis type.

Parameters:

chart - chart instance

id - axis id

type - axis type

kind - axis kind

Method Detail

getAxisElement

public Axis getAxisElement()

Description copied from interface: IsNumericAxis

Returns the axis instance.

Specified by:

getAxisElement in interface IsNumericAxis

Returns:

the axis

getTicks

public RadialLinearTick getTicks()

Returns the ticks element.

Returns:

the ticks

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.

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 add

property - 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 from org.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