Package com.vaadin.componentfactory.maps.model

Class AbstractDataLabels

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.AbstractDataLabels
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DataLabels
public abstract class AbstractDataLabels extends AbstractConfigurationObject

Abstract AbstractDataLabels class.

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

  • Constructor Details

    • AbstractDataLabels

      public AbstractDataLabels()

  • Method Details

    • getBackgroundColor

      public abstract Color getBackgroundColor()

      getBackgroundColor.

      Returns:
      a Color object.
      See Also:

    • setBackgroundColor

      public abstract void setBackgroundColor(Color backgroundColor)
      The background color or gradient for the data label.
      Parameters:
      backgroundColor - a Color object.

    • getBorderColor

      public abstract Color getBorderColor()

      getBorderColor.

      Returns:
      a Color object.
      See Also:

    • setBorderColor

      public abstract void setBorderColor(Color borderColor)
      The border color for the data label.
      Parameters:
      borderColor - a Color object.

    • getBorderRadius

      public abstract Number getBorderRadius()

      getBorderRadius.

      Returns:
      a Number object.
      See Also:

    • setBorderRadius

      public abstract void setBorderRadius(Number borderRadius)
      The border radius in pixels for the data label.
      Parameters:
      borderRadius - a Number object.

    • getBorderWidth

      public abstract Number getBorderWidth()

      getBorderWidth.

      Returns:
      a Number object.
      See Also:

    • setBorderWidth

      public abstract void setBorderWidth(Number borderWidth)
      The border width in pixels for the data label.
      Parameters:
      borderWidth - a Number object.

    • getColor

      public abstract Color getColor()

      getColor.

      Returns:
      a Color object.
      See Also:

    • setColor

      public abstract void setColor(Color color)
      The text color for the data labels.
      Parameters:
      color - a Color object.

    • getCrop

      public abstract Boolean getCrop()

      getCrop.

      Returns:
      a Boolean object.
      See Also:

    • setCrop

      public abstract void setCrop(Boolean crop)
      Whether to hide data labels that are outside the plot area. By default, the data label is moved inside the plot area according to the overflow option.
      Parameters:
      crop - a Boolean object.

    • setEnabled

      public abstract void setEnabled(Boolean enabled)
      Enable or disable the data labels.
      Parameters:
      enabled - a Boolean object.

    • getFormat

      public abstract String getFormat()

      getFormat.

      Returns:
      a String object.
      See Also:

    • setFormat

      public abstract void setFormat(String format)
      A format string for the data label. Available variables are the same as for formatter.
      Parameters:
      format - a String object.

    • getFormatter

      public abstract String getFormatter()

      getFormatter.

      Returns:
      a String object.
      See Also:

    • setFormatter

      public abstract void setFormatter(String _fn_formatter)
      Callback JavaScript function to format the data label. Note that if a format is defined, the format takes precedence and the formatter is ignored.
      Parameters:
      _fn_formatter - a String object.

    • getOverflow

      public abstract String getOverflow()

      getOverflow.

      Returns:
      a String object.
      See Also:

    • setOverflow

      public abstract void setOverflow(String overflow)
      How to handle data labels that flow outside the plot area. The default is justify, which aligns them inside the plot area. For columns and bars, this means it will be moved inside the bar. To display data labels outside the plot area, set crop to false and overflow to "none".
      Parameters:
      overflow - a String object.

    • getPadding

      public abstract Number getPadding()

      getPadding.

      Returns:
      a Number object.
      See Also:

    • setPadding

      public abstract void setPadding(Number padding)
      When either the borderWidth or the backgroundColor is set, this is the padding within the box.
      Parameters:
      padding - a Number object.

    • getRotation

      public abstract Number getRotation()

      getRotation.

      Returns:
      a Number object.
      See Also:

    • setRotation

      public abstract void setRotation(Number rotation)
      Text rotation in degrees. Note that due to a more complex structure, backgrounds, borders and padding will be lost on a rotated data label.
      Parameters:
      rotation - a Number object.

    • getShadow

      public abstract Boolean getShadow()

      getShadow.

      Returns:
      a Boolean object.
      See Also:

    • setShadow

      public abstract void setShadow(Boolean shadow)
      The shadow of the box.
      Parameters:
      shadow - a Boolean object.

    • getShape

      public abstract Shape getShape()

      getShape.

      Returns:
      a Shape object.
      See Also:

    • setShape

      public abstract void setShape(Shape shape)
      The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.
      Parameters:
      shape - a Shape object.

    • getStyle

      public abstract Style getStyle()

      getStyle.

      Returns:
      a Style object.
      See Also:

    • setStyle

      public abstract void setStyle(Style style)
      Styles for the label.
      Parameters:
      style - a Style object.

    • getUseHTML

      public abstract Boolean getUseHTML()

      getUseHTML.

      Returns:
      a Boolean object.
      See Also:

    • setUseHTML

      public abstract void setUseHTML(Boolean useHTML)
      Whether to use HTML to render the labels.
      Parameters:
      useHTML - a Boolean object.

    • getVerticalAlign

      public abstract VerticalAlign getVerticalAlign()

      getVerticalAlign.

      Returns:
      a VerticalAlign object.
      See Also:

    • setVerticalAlign

      public abstract void setVerticalAlign(VerticalAlign verticalAlign)
      The vertical alignment of a data label.
      Parameters:
      verticalAlign - a VerticalAlign object.