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 Description CartesianScaleLabel()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
encode()
Write the options of scale labelString
getFontColor()
Gets the fontColorString
getFontFamily()
Gets the fontFamilyNumber
getFontSize()
Gets the fontSizeString
getFontStyle()
Gets the fontStyleString
getLabelString()
Gets the labelStringObject
getLineHeight()
Gets the lineHeightObject
getPadding()
Gets the paddingboolean
isDisplay()
Gets the displayvoid
setDisplay(boolean display)
Sets the displayvoid
setFontColor(String fontColor)
Sets the fontColorvoid
setFontFamily(String fontFamily)
Sets the fontFamilyvoid
setFontSize(Number fontSize)
Sets the fontSizevoid
setFontStyle(String fontStyle)
Sets the fontStylevoid
setLabelString(String labelString)
Sets the labelStringvoid
setLineHeight(Object lineHeight)
Sets the lineHeightvoid
setPadding(Object padding)
Sets the padding
-
-
-
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
-
-