org.primefaces.model.charts.axes.cartesian

Class CartesianScaleLabel

java.lang.Object

org.primefaces.model.charts.axes.cartesian.CartesianScaleLabel

All Implemented Interfaces:

Serializable

public class CartesianScaleLabel
extends Object
implements Serializable

The scale label configuration is nested under the scale configuration in the scaleLabel key. It defines options for the scale title.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CartesianScaleLabel()

Method Summary

Modifier and Type	Method and Description
String	encode() Write the options of scale label
String	getFontColor() Gets the fontColor
String	getFontFamily() Gets the fontFamily
Number	getFontSize() Gets the fontSize
String	getFontStyle() Gets the fontStyle
String	getLabelString() Gets the labelString
Object	getLineHeight() Gets the lineHeight
Object	getPadding() Gets the padding
boolean	isDisplay() Gets the display
void	setDisplay(boolean display) Sets the display
void	setFontColor(String fontColor) Sets the fontColor
void	setFontFamily(String fontFamily) Sets the fontFamily
void	setFontSize(Number fontSize) Sets the fontSize
void	setFontStyle(String fontStyle) Sets the fontStyle
void	setLabelString(String labelString) Sets the labelString
void	setLineHeight(Object lineHeight) Sets the lineHeight
void	setPadding(Object padding) Sets the padding

Methods inherited from class java.lang.Object

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

Constructor Detail

CartesianScaleLabel

public CartesianScaleLabel()

Method Detail

isDisplay

public boolean isDisplay()

Gets the display

Returns:

display

setDisplay

public void setDisplay(boolean display)

Sets the display

Parameters:

display - If true, display the axis title.

getLabelString

public String getLabelString()

Gets the labelString

Returns:

labelString

setLabelString

public void setLabelString(String labelString)

Sets the labelString

Parameters:

labelString - The text for the title.

getLineHeight

public Object getLineHeight()

Gets the lineHeight

Returns:

lineHeight

setLineHeight

public void setLineHeight(Object lineHeight)

Sets the lineHeight

Parameters:

lineHeight - Height of an individual line of text

getFontColor

public String getFontColor()

Gets the fontColor

Returns:

fontColor

setFontColor

public void setFontColor(String fontColor)

Sets the fontColor

Parameters:

fontColor - Font color for scale title.

getFontFamily

public String getFontFamily()

Gets the fontFamily

Returns:

fontFamily

setFontFamily

public void setFontFamily(String fontFamily)

Sets the fontFamily

Parameters:

fontFamily - Font family for the scale title, follows CSS font-family options.

getFontSize

public Number getFontSize()

Gets the fontSize

Returns:

fontSize

setFontSize

public void setFontSize(Number fontSize)

Sets the fontSize

Parameters:

fontSize - Font size for scale title.

getFontStyle

public String getFontStyle()

Gets the fontStyle

Returns:

fontStyle

setFontStyle

public void setFontStyle(String fontStyle)

Sets the fontStyle

Parameters:

fontStyle - Font style for the scale title, follows CSS font-style options.

getPadding

public Object getPadding()

Gets the padding

Returns:

padding

setPadding

public void setPadding(Object padding)

Sets the padding

Parameters:

padding - Padding to apply around scale labels. Only top and bottom are implemented.

encode

public String encode()
              throws IOException

Write the options of scale label

Returns:

options as JSON object

Throws:

IOException - If an I/O error occurs