Package com.vaadin.componentfactory.maps.model

Class Tooltip

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Tooltip
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class Tooltip extends AbstractConfigurationObject
Options for the tooltip that appears when the user hovers over a series or point.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • Tooltip

      public Tooltip()

      Constructor for Tooltip.

    • Tooltip

      public Tooltip(Boolean enabled)

      Constructor for Tooltip.

      Parameters:
      enabled - a Boolean object.

  • Method Details

    • getAnimation

      public Boolean getAnimation()

      Getter for the field animation.

      Returns:
      a Boolean object.
      See Also:

    • setAnimation

      public void setAnimation(Boolean animation)
      Enable or disable animation of the tooltip. In slow legacy IE browsers the animation is disabled by default.

      Defaults to: true

      Parameters:
      animation - a Boolean object.

    • getBackgroundColor

      public Color getBackgroundColor()

      Getter for the field backgroundColor.

      Returns:
      a Color object.
      See Also:

    • setBackgroundColor

      public void setBackgroundColor(Color backgroundColor)
      The background color or gradient for the tooltip.

      Defaults to: rgba(255, 255, 255, 0.85)

      Parameters:
      backgroundColor - a Color object.

    • getBorderColor

      public Color getBorderColor()

      Getter for the field borderColor.

      Returns:
      a Color object.
      See Also:

    • setBorderColor

      public void setBorderColor(Color borderColor)
      The color of the tooltip border. When null, the border takes the color of the corresponding series or point.

      Defaults to: null

      Parameters:
      borderColor - a Color object.

    • getBorderRadius

      public Number getBorderRadius()

      Getter for the field borderRadius.

      Returns:
      a Number object.
      See Also:

    • setBorderRadius

      public void setBorderRadius(Number borderRadius)
      The radius of the rounded border corners.

      Defaults to: 3

      Parameters:
      borderRadius - a Number object.

    • getBorderWidth

      public Number getBorderWidth()

      Getter for the field borderWidth.

      Returns:
      a Number object.
      See Also:

    • setBorderWidth

      public void setBorderWidth(Number borderWidth)
      The pixel width of the tooltip border.

      Defaults to: 1

      Parameters:
      borderWidth - a Number 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 tooltip.

      Defaults to: true

      Parameters:
      enabled - a Boolean object.

    • getFollowPointer

      public Boolean getFollowPointer()

      Getter for the field followPointer.

      Returns:
      a Boolean object.
      See Also:

    • setFollowPointer

      public void setFollowPointer(Boolean followPointer)

      Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent. By default it behaves this way for scatter, bubble and pie series by override in the plotOptions for those series types.

      For touch moves to behave the same way, followTouchMove must be true also.

      Defaults to: true

      Parameters:
      followPointer - a Boolean object.

    • getFollowTouchMove

      public Boolean getFollowTouchMove()

      Getter for the field followTouchMove.

      Returns:
      a Boolean object.
      See Also:

    • setFollowTouchMove

      public void setFollowTouchMove(Boolean followTouchMove)
      Whether the tooltip should follow the finger as it moves on a touch device. If chart.zoomType is set, it will override followTouchMove.

      Defaults to: true

      Parameters:
      followTouchMove - a Boolean object.

    • getFooterFormat

      public String getFooterFormat()

      Getter for the field footerFormat.

      Returns:
      a String object.
      See Also:

    • setFooterFormat

      public void setFooterFormat(String footerFormat)
      A string to append to the tooltip format.

      Defaults to: false

      Parameters:
      footerFormat - 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.

    • getHeaderFormat

      public String getHeaderFormat()

      Getter for the field headerFormat.

      Returns:
      a String object.
      See Also:

    • setHeaderFormat

      public void setHeaderFormat(String headerFormat)

      The HTML of the tooltip header line. Variables are enclosed by curly brackets. Available variables are point.name, series.name, series.color and other members from the point and series objects.

      Defaults to <span style="font-size: 10px">{point.key}</span><br/>

      Parameters:
      headerFormat - a String object.

    • getHideDelay

      public Number getHideDelay()

      Getter for the field hideDelay.

      Returns:
      a Number object.
      See Also:

    • setHideDelay

      public void setHideDelay(Number hideDelay)
      The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.

      Defaults to: 500

      Parameters:
      hideDelay - a Number object.

    • getPointFormat

      public String getPointFormat()

      Getter for the field pointFormat.

      Returns:
      a String object.
      See Also:

    • setPointFormat

      public void setPointFormat(String pointFormat)

      The HTML of the point's line in the tooltip. Variables are enclosed by curly brackets. Available variables are point.value, series.name and series.color and other properties on the same form. Furthermore, point.value can be extended by the tooltip.valuePrefix and tooltip.valueSuffix variables. This can also be overridden for each series, which makes it a good hook for displaying units.

      For maps it defaults to '{point.name}: {point.value}<br/>'

      Parameters:
      pointFormat - a String object.

    • getPointFormatter

      public String getPointFormatter()

      getPointFormatter.

      Returns:
      a String object.

    • setPointFormatter

      public void setPointFormatter(String _fn_pointFormatter)

      setPointFormatter.

      Parameters:
      _fn_pointFormatter - a String object.

    • getPositioner

      public String getPositioner()

      getPositioner.

      Returns:
      a String object.

    • setPositioner

      public void setPositioner(String _fn_positioner)

      setPositioner.

      Parameters:
      _fn_positioner - a String object.

    • getShadow

      public Boolean getShadow()

      Getter for the field shadow.

      Returns:
      a Boolean object.
      See Also:

    • setShadow

      public void setShadow(Boolean shadow)
      Whether to apply a drop shadow to the tooltip.

      Defaults to: true

      Parameters:
      shadow - a Boolean 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 tooltip. The tooltip can also be styled through the CSS class .highcharts-tooltip.

      Defaults to: { "color": "#333333", "cursor": "default", "fontSize": "12px", "padding": "8px", "pointerEvents": "none", "whiteSpace": "nowrap" }

      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)
      Use HTML to render the contents of the tooltip instead of SVG. Using HTML allows advanced formatting like tables and images in the tooltip. It is also recommended for rtl languages as it works around rtl bugs in early Firefox.

      Defaults to: false

      Parameters:
      useHTML - a Boolean object.

    • getValueDecimals

      public Number getValueDecimals()

      Getter for the field valueDecimals.

      Returns:
      a Number object.
      See Also:

    • setValueDecimals

      public void setValueDecimals(Number valueDecimals)
      How many decimals to show in each series' value. This is overridable in each series' tooltip options object. The default is to preserve all decimals.
      Parameters:
      valueDecimals - a Number object.

    • getValuePrefix

      public String getValuePrefix()

      Getter for the field valuePrefix.

      Returns:
      a String object.
      See Also:

    • setValuePrefix

      public void setValuePrefix(String valuePrefix)
      A string to prepend to each series' value. Overridable in each series' tooltip options object.
      Parameters:
      valuePrefix - a String object.

    • getValueSuffix

      public String getValueSuffix()

      Getter for the field valueSuffix.

      Returns:
      a String object.
      See Also:

    • setValueSuffix

      public void setValueSuffix(String valueSuffix)
      A string to append to each series' value. Overridable in each series' tooltip options object.
      Parameters:
      valueSuffix - a String object.