Method Details

• getAlign

  public HorizontalAlign getAlign()

  See Also:

  • setAlign(HorizontalAlign)

• setAlign

  public void setAlign(HorizontalAlign align)

  Horizontal alignment of the label. Can be one of "left", "center" or "right".

  Defaults to: left

• getRotation

  public Number getRotation()

  See Also:

  • setRotation(Number)

• setRotation

  public void setRotation(Number rotation)

  Rotation of the text label in degrees. Defaults to 0 for horizontal plot lines and 90 for vertical lines.

• getStyle

  public Style getStyle()

  See Also:

  • setStyle(Style)

• setStyle

  public void setStyle(Style style)

  CSS styles for the text label.

  In styled mode, the labels are styled by the .highcharts-plot-band-label class.

• getText

  public String getText()

  See Also:

  • setText(String)

• setText

  public void setText(String text)

  The text itself. A subset of HTML is supported.

• getTextAlign

  public TextAlign getTextAlign()

  See Also:

  • setTextAlign(TextAlign)

• setTextAlign

  public void setTextAlign(TextAlign textAlign)

  The text alignment for the label. While align determines where the texts anchor point is placed within the plot band, textAlign determines how the text is aligned against its anchor point. Possible values are "left", "center" and "right". Defaults to the same as the align option.

• getUseHTML

  public Boolean getUseHTML()

  See Also:

  • setUseHTML(Boolean)

• setUseHTML

  public void setUseHTML(Boolean useHTML)

  Whether to use HTML to render the labels.

  Defaults to: false

• getVerticalAlign

  public VerticalAlign getVerticalAlign()

  See Also:

  • setVerticalAlign(VerticalAlign)

• setVerticalAlign

  public void setVerticalAlign(VerticalAlign verticalAlign)

  Vertical alignment of the label relative to the plot band. Can be one of "top", "middle" or "bottom".

  Defaults to: top

• getX

  public Number getX()

  See Also:

  • setX(Number)

• setX

  public void setX(Number x)

  Horizontal position relative the alignment. Default varies by orientation.

• getY

  public Number getY()

  See Also:

  • setY(Number)

• setY

  public void setY(Number y)

  Vertical position of the text baseline relative to the alignment. Default varies by orientation.