Package com.vaadin.componentfactory.maps.model

Class SeriesTooltip

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.SeriesTooltip
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class SeriesTooltip extends AbstractConfigurationObject
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • SeriesTooltip

      public SeriesTooltip()

      Constructor for SeriesTooltip.

  • Method Details

    • 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.

    • 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.

    • 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.