Package com.vaadin.componentfactory.maps.model

Class Labels

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Labels
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class Labels extends AbstractConfigurationObject

The axis labels show the number or category for each tick. X and Y axis labels are by default disabled in Highmaps, but the functionality is inherited from Highcharts and used on colorAxis, and can be enabled on X and Y axes too.

For more live examples on label options, see yAxis.labels in the Highcharts API.

Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Labels

      public Labels()

      Constructor for Labels.

    • Labels

      public Labels(Boolean enabled)

      Constructor for Labels.

      Parameters:
      enabled - a Boolean object.

  • Method Details

    • getAlign

      public HorizontalAlign getAlign()

      Getter for the field align.

      Returns:
      a HorizontalAlign object.
      See Also:

    • setAlign

      public void setAlign(HorizontalAlign align)
      What part of the string the given position is anchored to. Can be one of "left", "center" or "right".

      Defaults to: right

      Parameters:
      align - a HorizontalAlign object.

    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:

    • setEnabled

      public void setEnabled(Boolean enabled)
      Enable or disable the axis labels.

      Defaults to: false

      Parameters:
      enabled - a Boolean object.

    • getFormat

      public String getFormat()

      Getter for the field format.

      Returns:
      a String object.
      See Also:

    • setFormat

      public void setFormat(String format)
      A format string for the axis label.

      Defaults to: {value}

      Parameters:
      format - a String object.

    • getFormatter

      public String getFormatter()

      getFormatter.

      Returns:
      a String object.

    • setFormatter

      public void setFormatter(String _fn_formatter)

      setFormatter.

      Parameters:
      _fn_formatter - a String object.

    • getStaggerLines

      public Number getStaggerLines()

      Getter for the field staggerLines.

      Returns:
      a Number object.
      See Also:

    • setStaggerLines

      public void setStaggerLines(Number staggerLines)
      Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels. .
      Parameters:
      staggerLines - a Number object.

    • getStep

      public Number getStep()

      Getter for the field step.

      Returns:
      a Number object.
      See Also:

    • setStep

      public void setStep(Number step)
      To show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label.
      Parameters:
      step - 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 label.

      Defaults to: {"color":"#6D869F","fontWeight":"bold"}

      Parameters:
      style - a Style 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 labels.

      Defaults to: false

      Parameters:
      useHTML - a Boolean 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 offset of the label relative to the tick position on the axis. Defaults to -15 for left axis, 15 for right axis.
      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 offset of the label relative to the tick position on the axis.

      Defaults to: 3

      Parameters:
      y - a Number object.

    • getZIndex

      public Number getZIndex()

      Getter for the field zIndex.

      Returns:
      a Number object.
      See Also:

    • setZIndex

      public void setZIndex(Number zIndex)
      The Z index for the axis labels.

      Defaults to: 7

      Parameters:
      zIndex - a Number object.

    • getOverflow

      public String getOverflow()

      Getter for the field overflow.

      Returns:
      a String object.
      See Also:

    • setOverflow

      public void setOverflow(String overflow)
      How to handle overflowing labels on horizontal axis. Can be undefined or "justify". If "justify", labels will not render outside the plot area. If there is room to move it, it will be aligned to the edge, else it will be removed.

      Defaults to: justify

      Parameters:
      overflow - a String object.

    • getRotation

      public String getRotation()

      Getter for the field rotation.

      Returns:
      a String object.

    • setRotation

      public void setRotation(String rotation)

      Setter for the field rotation.

      Parameters:
      rotation - a String object.

    • setRotation

      public void setRotation(Number rotation)

      Setter for the field rotation.

      Parameters:
      rotation - a Number object.

    • setRotationPerpendicular

      public void setRotationPerpendicular()

      setRotationPerpendicular.