org.pepstock.charba.client.configuration

Class RadialAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.RadialAxis

public class RadialAxis
extends Axis

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

Constructor and Description
RadialAxis(IsChart chart) Builds the object storing the chart instance.

Method Summary

Modifier and Type	Method and Description
RadialAngleLines	getAngleLines() Returns the angle lines element.
AxisBuildTicksCallback	getAxisBuildTicksCallback() Returns the user callback that runs before/after ticks are created.
IsChart	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
GridLines	getGrideLines() Returns the grid lines element.
RadialPointLabels	getPointLabels() Returns the point labels element.
RadialLinearTick	getTicks() Returns the ticks element.
void	merge(NativeObjectContainer source, String property) Merge a native object into 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 into options of chart.
void	setAxisBuildTicksCallback(AxisBuildTicksCallback axisBuildTicksCallback) Sets the user callback that runs before/after ticks are created.
protected void	setConfiguration(T configuration)
String	toJSON() Returns the JSON representation of the object.

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

getAxisCalculateTickRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getCharbaId, getDisplay, getType, getWeight, setAxisCalculateTickRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setDisplay, setDisplay, setWeight

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RadialAxis

public RadialAxis(IsChart chart)

Builds the object storing the chart instance.

Parameters:

chart - chart instance

Method Detail

getTicks

public RadialLinearTick getTicks()

Returns the ticks element.

Returns:

the ticks

getGrideLines

public GridLines getGrideLines()

Returns the grid lines element.

Returns:

the grideLines

getAngleLines

public RadialAngleLines getAngleLines()

Returns the angle lines element.

Returns:

the angleLines

getPointLabels

public RadialPointLabels getPointLabels()

Returns the point labels element.

Returns:

the pointLabels

getAxisBuildTicksCallback

public AxisBuildTicksCallback getAxisBuildTicksCallback()

Returns the user callback that runs before/after ticks are created.

Returns:

the axisBuildTicksCallback

setAxisBuildTicksCallback

public void setAxisBuildTicksCallback(AxisBuildTicksCallback axisBuildTicksCallback)

Sets the user callback that runs before/after ticks are created.

Parameters:

axisBuildTicksCallback - the axisBuildTicksCallback to 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 into 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 into 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.

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart