Package org.pepstock.charba.client.configuration

Interface IsNumericAxis

All Known Subinterfaces:

IsLinearAxis

All Known Implementing Classes:

CartesianLinearAxis, CartesianLogarithmicAxis, ColorAxis, ColorLogarithmicAxis, RadialAxis, SizeAxis, SizeLogarithmicAxis

public interface IsNumericAxis

Common methods for numeric scales (linear/log cartesian and radial).

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
Axis	getAxisElement()	Returns the axis instance.
default double	getMax()	Returns the user defined maximum number for the scale, overrides maximum value from data.
default double	getMin()	Returns the user defined minimum number for the scale, overrides minimum value from data.
default double	getSuggestedMax()	Returns the adjustment used when calculating the maximum data value.
default double	getSuggestedMin()	Returns the adjustment used when calculating the minimum data value.
default void	setMax(double max)	Sets the user defined maximum number for the scale, overrides maximum value from data.
default void	setMin(double min)	Sets the user defined minimum number for the scale, overrides minimum value from data.
default void	setSuggestedMax(double suggestedMax)	Sets the adjustment used when calculating the maximum data value.
default void	setSuggestedMin(double suggestedMin)	Sets the adjustment used when calculating the minimum data value.

Method Detail

getAxisElement

Axis getAxisElement()

Returns the axis instance.

Returns:

the axis

setMin

default void setMin(double min)

Sets the user defined minimum number for the scale, overrides minimum value from data.

Parameters:

min - the user defined minimum number for the scale, overrides minimum value from data.

getMin

default double getMin()

Returns the user defined minimum number for the scale, overrides minimum value from data.

Returns:

the user defined minimum number for the scale, overrides minimum value from data.

setMax

default void setMax(double max)

Sets the user defined maximum number for the scale, overrides maximum value from data.

Parameters:

max - user defined maximum number for the scale, overrides maximum value from data.

getMax

default double getMax()

Returns the user defined maximum number for the scale, overrides maximum value from data.

Returns:

user defined maximum number for the scale, overrides maximum value from data.

setSuggestedMax

default void setSuggestedMax(double suggestedMax)

Sets the adjustment used when calculating the maximum data value.

Parameters:

suggestedMax - adjustment used when calculating the maximum data value.

getSuggestedMax

default double getSuggestedMax()

Returns the adjustment used when calculating the maximum data value.

Returns:

adjustment used when calculating the maximum data value.

setSuggestedMin

default void setSuggestedMin(double suggestedMin)

Sets the adjustment used when calculating the minimum data value.

Parameters:

suggestedMin - adjustment used when calculating the minimum data value.

getSuggestedMin

default double getSuggestedMin()

Returns the adjustment used when calculating the minimum data value.

Returns:

adjustment used when calculating the minimum data value.