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

Class CartesianCategoryAxes

java.lang.Object

org.primefaces.model.charts.axes.cartesian.CartesianAxes

org.primefaces.model.charts.axes.cartesian.category.CartesianCategoryAxes

All Implemented Interfaces:

Serializable

public class CartesianCategoryAxes
extends CartesianAxes

If global configuration is used, labels are drawn from one of the label arrays included in the chart data. If only data.labels is defined, this will be used. If data.xLabels is defined and the axis is horizontal, this will be used. Similarly, if data.yLabels is defined and the axis is vertical, this property will be used. Using both xLabels and yLabels together can create a chart that uses strings for both the X and Y axes. CartesianCategoryAxes extends CartesianAxes.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CartesianCategoryAxes()

Method Summary

Modifier and Type	Method	Description
String	encode()	Write the options of cartesian category axes
List<String>	getLabels()	Gets the labels
CartesianCategoryTicks	getTicks()	Gets the ticks
String	getType()	Gets the type
void	setLabels(List<String> labels)	Sets the labels
void	setTicks(CartesianCategoryTicks ticks)	Sets the ticks
void	setType(String type)	Sets the type

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

getGrid, getId, getMax, getMin, getPosition, getScaleTitle, getSuggestedMax, getSuggestedMin, isOffset, isReverse, isStacked, setGrid, setId, setMax, setMin, setOffset, setPosition, setReverse, setScaleTitle, setStacked, setSuggestedMax, setSuggestedMin

Methods inherited from class java.lang.Object

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

Constructor Details

CartesianCategoryAxes

public CartesianCategoryAxes()

Method Details

getTicks

public CartesianCategoryTicks getTicks()

Gets the ticks

Returns:

ticks

setTicks

public void setTicks(CartesianCategoryTicks ticks)

Sets the ticks

Parameters:

ticks - the CartesianCategoryTicks object

getType

public String getType()

Gets the type

Returns:

type of cartesian axes

setType

public void setType(String type)

Sets the type

Parameters:

type - the type of cartesian axes

getLabels

public List<String> getLabels()

Gets the labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

Sets the labels

Parameters:

labels - List<String> list of labels to display.

encode

public String encode()
              throws IOException

Write the options of cartesian category axes

Overrides:

encode in class CartesianAxes

Returns:

options as JSON object

Throws:

IOException - If an I/O error occurs