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 extendsCartesianTicks
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CartesianLinearTicks()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
encode()
Write the options of cartesian linear ticksNumber
getMax()
Gets the maxNumber
getMaxTicksLimit()
Gets the maxTicksLimitNumber
getMin()
Gets the minNumber
getPrecision()
If defined and stepSize is not specified, the step size will be rounded to this many decimal places.Number
getStepSize()
Gets the stepSizeNumber
getSuggestedMax()
Gets the suggestedMaxNumber
getSuggestedMin()
Gets the suggestedMinboolean
isBeginAtZero()
Gets the beginAtZerovoid
setBeginAtZero(boolean beginAtZero)
Sets the beginAtZerovoid
setMax(Number max)
Sets the maxvoid
setMaxTicksLimit(Number maxTicksLimit)
Sets the maxTicksLimitvoid
setMin(Number min)
Sets the minvoid
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 stepSizevoid
setSuggestedMax(Number suggestedMax)
Sets the suggestedMaxvoid
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
-
-
-
-
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 classCartesianTicks
- Returns:
- options as JSON object
- Throws:
IOException
- If an I/O error occurs
-
-