Package org.pepstock.charba.client.configuration

Class CartesianLinearAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.CartesianAxis<CartesianLinearTick>

org.pepstock.charba.client.configuration.CartesianLinearAxis

All Implemented Interfaces:

IsLinearAxis, IsNumericAxis

Direct Known Subclasses:

ColorAxis, SizeAxis

public class CartesianLinearAxis
extends CartesianAxis<CartesianLinearTick>
implements IsLinearAxis

This object is used to map defined axis as linear.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor	Description
	CartesianLinearAxis(IsChart chart)	Builds the object storing the chart instance.
	CartesianLinearAxis(IsChart chart, String id)	Builds the object storing the chart instance.
	CartesianLinearAxis(IsChart chart, String id, AxisKind kind)	Builds the object storing the chart instance and axis type.
	CartesianLinearAxis(IsChart chart, AxisKind kind)	Builds the object storing the chart instance and axis type.
	CartesianLinearAxis(IsChart chart, ScaleId id)	Builds the object storing the chart instance.
protected	CartesianLinearAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind)	Builds the object storing the chart instance and cartesian axis type, to use to extend the axis.
	CartesianLinearAxis(IsChart chart, ScaleId id, AxisKind kind)	Builds the object storing the chart instance and axis type.

Method Summary

Modifier and Type	Method	Description
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.
IsChart	getChart()	Returns the chart instance
protected T	getConfiguration()	Returns the configuration element.
int	getGrace()	Returns the value in pixels is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
double	getGraceAsPercentage()	Returns the value in percentage, value between 0 and 1, is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
GraceCallback	getGraceCallback()	Returns the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.
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()
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.
CartesianLinearTick	getTicks()	Returns the ticks element
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.
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)
void	setGrace(int grace)	Sets the value in pixels is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
void	setGrace(GraceCallback graceCallback)	Sets the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.
void	setGrace(NativeCallback graceCallback)	Sets the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.
void	setGraceAsPercentage(double grace)	Sets the value in percentage, value between 0 and 1, is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.
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.
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.CartesianAxis

getBounds, getBoundsCallback, getGrid, getOffsetCallback, getPosition, getPositionCallback, getStack, getStackCallback, getStackedCallback, getStackWeight, getStackWeightCallback, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setBounds, setBounds, setOffset, setOffset, setOffset, setPosition, setPosition, setPosition, setSingleStacked, setStack, setStack, setStack, setStacked, setStacked, setStacked, setStackWeight, setStackWeight, setStackWeight

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, 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

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart)

Builds the object storing the chart instance. Axis type is Y by default.

Parameters:

chart - chart instance

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           String id)

Builds the object storing the chart instance. Axis type is Y by default.

Parameters:

chart - chart instance

id - axis id

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           ScaleId id)

Builds the object storing the chart instance. Axis type is Y by default.

Parameters:

chart - chart instance

id - axis id

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

kind - axis kind.

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           String id,
                           AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

id - axis id

kind - axis kind.

CartesianLinearAxis

public CartesianLinearAxis(IsChart chart,
                           ScaleId id,
                           AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

id - axis id

kind - axis kind.

CartesianLinearAxis

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

Builds the object storing the chart instance and cartesian axis type, to use to extend the axis.

Parameters:

chart - chart instance

id - axis id

type - axis type

kind - axis kind

Method Detail

getAxisElement

public final Axis getAxisElement()

Description copied from interface: IsNumericAxis

Returns the axis instance.

Specified by:

getAxisElement in interface IsNumericAxis

Returns:

the axis

getMinMaxCallbacksHandler

public org.pepstock.charba.client.configuration.MinMaxCallbacksHandler<Double> getMinMaxCallbacksHandler()

getBegiAtZeroCallbackHandler

public org.pepstock.charba.client.configuration.BegiAtZeroCallbackHandler getBegiAtZeroCallbackHandler()

getTicks

public CartesianLinearTick getTicks()

Description copied from class: CartesianAxis

Returns the ticks element

Specified by:

getTicks in class CartesianAxis<CartesianLinearTick>

Returns:

the ticks

setGrace

public void setGrace(int grace)

Sets the value in pixels is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Parameters:

grace - the value in pixels is added to the maximum data value and subtracted from the minimum data

getGrace

public int getGrace()

Returns the value in pixels is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Returns:

the value in pixels is added to the maximum data value and subtracted from the minimum data

setGraceAsPercentage

public void setGraceAsPercentage(double grace)

Sets the value in percentage, value between 0 and 1, is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Parameters:

grace - the value in percentage is added to the maximum data value and subtracted from the minimum data

getGraceAsPercentage

public double getGraceAsPercentage()

Returns the value in percentage, value between 0 and 1, is added to the maximum data value and subtracted from the minimum data.
This extends the scale range as if the data values were that much greater.

Returns:

the value in percentage is added to the maximum data value and subtracted from the minimum data

getGraceCallback

public GraceCallback getGraceCallback()

Returns the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.

Returns:

the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.

setGrace

public void setGrace(GraceCallback graceCallback)

Sets the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.

Parameters:

graceCallback - the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.

setGrace

public void setGrace(NativeCallback graceCallback)

Sets the user callback that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.

Parameters:

graceCallback - that sets the value in pixels is added to the maximum data value and subtracted from the minimum data.

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 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