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

Class CartesianScaleTitle

java.lang.Object
org.primefaces.model.charts.axes.cartesian.CartesianScaleTitle
All Implemented Interfaces:
Serializable
public class CartesianScaleTitle 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:

  • Constructor Details

    • CartesianScaleTitle

      public CartesianScaleTitle()

  • Method Details

    • 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.

    • getText

      public String getText()
      Gets the title text
      Returns:
      text

    • setText

      public void setText(String text)
      Sets the title text
      Parameters:
      text - The text for the title.

    • getAlign

      public String getAlign()
      Gets the align
      Returns:
      align

    • setAlign

      public void setAlign(String align)
      Alignment of the axis title. Possible options are 'start', 'center' and 'end'
      Parameters:
      align - The align 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.

    • getFont

      public ChartFont getFont()

    • setFont

      public void setFont(ChartFont font)

    • 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