Package org.primefaces.model.charts.axes.cartesian.linear

Class CartesianLinearTicks

java.lang.Object

org.primefaces.model.charts.axes.cartesian.CartesianTicks

org.primefaces.model.charts.axes.cartesian.linear.CartesianLinearTicks

All Implemented Interfaces:

Serializable

public class CartesianLinearTicks
extends CartesianTicks

Used to provide cartesian linear ticks. CartesianLinearTicks extends CartesianTicks

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CartesianLinearTicks()

Method Summary

Modifier and Type	Method	Description
String	encode()	Write the options of cartesian linear ticks
Number	getMax()	Gets the max
Number	getMaxTicksLimit()	Gets the maxTicksLimit
Number	getMin()	Gets the min
Number	getPrecision()	If defined and stepSize is not specified, the step size will be rounded to this many decimal places.
Number	getStepSize()	Gets the stepSize
Number	getSuggestedMax()	Gets the suggestedMax
Number	getSuggestedMin()	Gets the suggestedMin
boolean	isBeginAtZero()	Gets the beginAtZero
void	setBeginAtZero(boolean beginAtZero)	Sets the beginAtZero
void	setMax(Number max)	Sets the max
void	setMaxTicksLimit(Number maxTicksLimit)	Sets the maxTicksLimit
void	setMin(Number min)	Sets the min
void	setPrecision(Number precision)	If defined and stepSize is not specified, the step size will be rounded to this many decimal places.
void	setStepSize(Number stepSize)	Sets the stepSize
void	setSuggestedMax(Number suggestedMax)	Sets the suggestedMax
void	setSuggestedMin(Number suggestedMin)	Sets the suggestedMin

Methods inherited from class org.primefaces.model.charts.axes.cartesian.CartesianTicks

getAutoSkipPadding, getLabelOffset, getMaxRotation, getMinRotation, getPadding, isAutoSkip, isMirror, setAutoSkip, setAutoSkipPadding, setLabelOffset, setMaxRotation, setMinRotation, setMirror, setPadding

Methods inherited from class java.lang.Object

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

Constructor Detail

CartesianLinearTicks

public CartesianLinearTicks()

Method Detail

isBeginAtZero

public boolean isBeginAtZero()

Gets the beginAtZero

Returns:

beginAtZero

setBeginAtZero

public void setBeginAtZero(boolean beginAtZero)

Sets the beginAtZero

Parameters:

beginAtZero - if true, scale will include 0 if it is not already included.

getMin

public Number getMin()

Gets the min

Returns:

min

setMin

public void setMin(Number min)

Sets the min

Parameters:

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

getMax

public Number getMax()

Gets the max

Returns:

max

setMax

public void setMax(Number max)

Sets the max

Parameters:

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

getMaxTicksLimit

public Number getMaxTicksLimit()

Gets the maxTicksLimit

Returns:

maxTicksLimit

setMaxTicksLimit

public void setMaxTicksLimit(Number maxTicksLimit)

Sets the maxTicksLimit

Parameters:

maxTicksLimit - Maximum number of ticks and gridlines to show.

getPrecision

public Number getPrecision()

If defined and stepSize is not specified, the step size will be rounded to this many decimal places.

Returns:

the current precision

setPrecision

public void setPrecision(Number precision)

If defined and stepSize is not specified, the step size will be rounded to this many decimal places.

Parameters:

precision - User defined precision for the scale.

getStepSize

public Number getStepSize()

Gets the stepSize

Returns:

stepSize

setStepSize

public void setStepSize(Number stepSize)

Sets the stepSize

Parameters:

stepSize - User defined fixed step size for the scale.

getSuggestedMax

public Number getSuggestedMax()

Gets the suggestedMax

Returns:

suggestedMax

setSuggestedMax

public void setSuggestedMax(Number suggestedMax)

Sets the suggestedMax

Parameters:

suggestedMax - Adjustment used when calculating the maximum data value.

getSuggestedMin

public Number getSuggestedMin()

Gets the suggestedMin

Returns:

suggestedMin

setSuggestedMin

public void setSuggestedMin(Number suggestedMin)

Sets the suggestedMin

Parameters:

suggestedMin - Adjustment used when calculating the minimum data value.

encode

public String encode()
              throws IOException

Write the options of cartesian linear ticks

Overrides:

encode in class CartesianTicks

Returns:

options as JSON object

Throws:

IOException - If an I/O error occurs