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

Class RadialLinearTicks

java.lang.Object

org.primefaces.model.charts.axes.AxesTicks

org.primefaces.model.charts.axes.radial.linear.RadialLinearTicks

All Implemented Interfaces:

Serializable

public class RadialLinearTicks
extends AxesTicks

Used to provide radial linear ticks. RadialLinearTicks extends AxesTicks

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RadialLinearTicks()

Method Summary

Modifier and Type	Method	Description
String	encode()	Write the radial linear ticks
String	getBackdropColor()	Gets the backdropColor
Number	getBackdropPaddingX()	Gets the backdropPaddingX
Number	getBackdropPaddingY()	Gets the backdropPaddingY
Number	getMax()	Gets the max
Number	getMaxTicksLimit()	Gets the maxTicksLimit
Number	getMin()	Gets the min
Number	getStepSize()	Gets the stepSize
Number	getSuggestedMax()	Gets the suggestedMax
Number	getSuggestedMin()	Gets the suggestedMin
boolean	isBeginAtZero()	Gets the beginAtZero
boolean	isShowLabelBackdrop()	Gets the showLabelBackdrop
void	setBackdropColor(String backdropColor)	Sets the backdropColor
void	setBackdropPaddingX(Number backdropPaddingX)	Sets the backdropPaddingX
void	setBackdropPaddingY(Number backdropPaddingY)	Sets the backdropPaddingY
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	setShowLabelBackdrop(boolean showLabelBackdrop)	Sets the showLabelBackdrop
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.AxesTicks

getFontColor, getFontFamily, getFontSize, getFontStyle, isDisplay, isReverse, setDisplay, setFontColor, setFontFamily, setFontSize, setFontStyle, setReverse

Methods inherited from class java.lang.Object

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

Constructor Detail

RadialLinearTicks

public RadialLinearTicks()

Method Detail

getBackdropColor

public String getBackdropColor()

Gets the backdropColor

Returns:

backdropColor

setBackdropColor

public void setBackdropColor(String backdropColor)

Sets the backdropColor

Parameters:

backdropColor - Color of label backdrops

getBackdropPaddingX

public Number getBackdropPaddingX()

Gets the backdropPaddingX

Returns:

backdropPaddingX

setBackdropPaddingX

public void setBackdropPaddingX(Number backdropPaddingX)

Sets the backdropPaddingX

Parameters:

backdropPaddingX - Horizontal padding of label backdrop.

getBackdropPaddingY

public Number getBackdropPaddingY()

Gets the backdropPaddingY

Returns:

backdropPaddingY

setBackdropPaddingY

public void setBackdropPaddingY(Number backdropPaddingY)

Sets the backdropPaddingY

Parameters:

backdropPaddingY - Vertical padding of label backdrop.

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.

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.

isShowLabelBackdrop

public boolean isShowLabelBackdrop()

Gets the showLabelBackdrop

Returns:

showLabelBackdrop

setShowLabelBackdrop

public void setShowLabelBackdrop(boolean showLabelBackdrop)

Sets the showLabelBackdrop

Parameters:

showLabelBackdrop - If true, draw a background behind the tick labels

encode

public String encode()
              throws IOException

Write the radial linear ticks

Overrides:

encode in class AxesTicks

Returns:

options as JSON object

Throws:

IOException - If an I/O error occurs