Package com.vaadin.componentfactory.maps.model

Class Subtitle

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Subtitle
All Implemented Interfaces:
Serializable
@Generated(value="This class is generated and shouldn\'t be modified", comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new") public class Subtitle extends AbstractConfigurationObject
The map's subtitle
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Subtitle

      public Subtitle()

      Constructor for Subtitle.

    • Subtitle

      public Subtitle(String text)

      Constructor for Subtitle.

      Parameters:
      text - a String object.

  • Method Details

    • getAlign

      public HorizontalAlign getAlign()

      Getter for the field align.

      Returns:
      a HorizontalAlign object.
      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

      Parameters:
      align - a HorizontalAlign object.

    • getFloating

      public Boolean getFloating()

      Getter for the field floating.

      Returns:
      a Boolean object.
      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

      Parameters:
      floating - a Boolean object.

    • getText

      public String getText()

      Getter for the field text.

      Returns:
      a String object.
      See Also:

    • setText

      public void setText(String text)
      The subtitle of the map.
      Parameters:
      text - a String object.

    • getUseHTML

      public Boolean getUseHTML()

      Getter for the field useHTML.

      Returns:
      a Boolean object.
      See Also:

    • setUseHTML

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

      Defaults to: false

      Parameters:
      useHTML - a Boolean object.

    • getVerticalAlign

      public VerticalAlign getVerticalAlign()

      Getter for the field verticalAlign.

      Returns:
      a VerticalAlign object.
      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:

      Parameters:
      verticalAlign - a VerticalAlign object.

    • getWidthAdjust

      public Number getWidthAdjust()

      Getter for the field widthAdjust.

      Returns:
      a Number object.
      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

      Parameters:
      widthAdjust - a Number object.

    • getX

      public Number getX()

      Getter for the field x.

      Returns:
      a Number object.
      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

      Parameters:
      x - a Number object.

    • getY

      public Number getY()

      Getter for the field y.

      Returns:
      a Number object.
      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

      Parameters:
      y - a Number object.

    • getStyle

      public CSSObject getStyle()

      Getter for the field style.

      Returns:
      a CSSObject object.

    • setStyle

      public void setStyle(CSSObject style)

      Setter for the field style.

      Parameters:
      style - a CSSObject object.