Package com.vaadin.componentfactory.maps.model

Class AxisTitle

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.AxisTitle
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class AxisTitle extends AbstractConfigurationObject
The axis title. In Highmaps, the axis is hidden by default, but adding an axis title is still possible. X axis and Y axis titles will appear at the bottom and left by default.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • AxisTitle

      public AxisTitle()

      Constructor for AxisTitle.

    • AxisTitle

      public AxisTitle(String text)

      Constructor for AxisTitle.

      Parameters:
      text - a String object.

  • Method Details

    • getAlign

      public VerticalAlign getAlign()

      Getter for the field align.

      Returns:
      a VerticalAlign object.
      See Also:

    • setAlign

      public void setAlign(VerticalAlign align)
      Alignment of the title relative to the axis values. Possible values are "low", "middle" or "high".

      Defaults to: middle

      Parameters:
      align - a VerticalAlign object.

    • getMargin

      public Number getMargin()

      Getter for the field margin.

      Returns:
      a Number object.
      See Also:

    • setMargin

      public void setMargin(Number margin)
      The pixel distance between the axis labels and the title. Positive values are outside the axis line, negative are inside.

      Defaults to: 40

      Parameters:
      margin - a Number object.

    • getOffset

      public Number getOffset()

      Getter for the field offset.

      Returns:
      a Number object.
      See Also:

    • setOffset

      public void setOffset(Number offset)
      The distance of the axis title from the axis line. By default, this distance is computed from the offset width of the labels, the labels' distance from the axis and the title's margin. However when the offset option is set, it overrides all this.
      Parameters:
      offset - a Number object.

    • getRotation

      public Number getRotation()

      Getter for the field rotation.

      Returns:
      a Number object.
      See Also:

    • setRotation

      public void setRotation(Number rotation)
      The rotation of the text in degrees. 0 is horizontal, 270 is vertical reading from bottom to top.

      Defaults to: 270

      Parameters:
      rotation - a Number object.

    • getStyle

      public Style getStyle()

      Getter for the field style.

      Returns:
      a Style object.
      See Also:

    • setStyle

      public void setStyle(Style style)
      CSS styles for the title. When titles are rotated they are rendered using vector graphic techniques and not all styles are applicable.

      Defaults to: { "color": "#707070", "fontWeight": "bold" }

      Parameters:
      style - a Style object.

    • getText

      public String getText()

      Getter for the field text.

      Returns:
      a String object.
      See Also:

    • setText

      public void setText(String text)
      The actual text of the axis title. It can contain basic HTML text markup like <b>, <i> and spans with style.
      Parameters:
      text - a String object.