Class Subtitle

All Implemented Interfaces:
Serializable

public class Subtitle extends AbstractConfigurationObject
The chart's subtitle
See Also:
  • Constructor Details

    • Subtitle

      public Subtitle()
    • Subtitle

      public Subtitle(String text)
  • Method Details

    • getAlign

      public HorizontalAlign getAlign()
      See Also:
    • setAlign

      public void setAlign(HorizontalAlign align)
      The horizontal alignment of the subtitle. Can be one of "left", "center" and "right".

      Defaults to: center

    • getFloating

      public Boolean getFloating()
      See Also:
    • setFloating

      public void setFloating(Boolean floating)
      When the subtitle is floating, the plot area will not move to make space for it.

      Defaults to: false

    • getStyle

      public Style getStyle()
      See Also:
    • setStyle

      public void setStyle(Style style)

      CSS styles for the title.

      In styled mode, the subtitle style is given in the .highcharts-subtitle class.

      Defaults to: { "color": "#666666" }

    • getText

      public String getText()
      See Also:
    • setText

      public void setText(String text)
      The subtitle of the chart.
    • getUseHTML

      public Boolean getUseHTML()
      See Also:
    • setUseHTML

      public void setUseHTML(Boolean useHTML)
      Whether to use HTML to render the text.

      Defaults to: false

    • getVerticalAlign

      public VerticalAlign getVerticalAlign()
      See Also:
    • setVerticalAlign

      public void setVerticalAlign(VerticalAlign verticalAlign)
      The vertical alignment of the title. Can be one of "top", "middle" and "bottom". When a value is given, the title behaves as floating.

      Defaults to:

    • getWidthAdjust

      public Number getWidthAdjust()
      See Also:
    • setWidthAdjust

      public void setWidthAdjust(Number widthAdjust)
      Adjustment made to the subtitle width, normally to reserve space for the exporting burger menu.

      Defaults to: -44

    • getX

      public Number getX()
      See Also:
    • setX

      public void setX(Number x)
      The x position of the subtitle relative to the alignment within chart.spacingLeft and chart.spacingRight.

      Defaults to: 0

    • getY

      public Number getY()
      See Also:
    • setY

      public void setY(Number y)
      The y position of the subtitle relative to the alignment within chart.spacingTop and chart.spacingBottom. By default the subtitle is laid out below the title unless the title is floating.

      Defaults to: null