Package com.vaadin.flow.component.charts.model

Class SeriesTooltip

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.SeriesTooltip
All Implemented Interfaces:
Serializable
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.
See Also:

  • Constructor Details

    • SeriesTooltip

      public SeriesTooltip()

  • Method Details

    • getDateTimeLabelFormats

      public DateTimeLabelFormats getDateTimeLabelFormats()
      See Also:

    • setDateTimeLabelFormats

      public void setDateTimeLabelFormats(DateTimeLabelFormats dateTimeLabelFormats)

      For series on a datetime axes, the date format in the tooltip's header will by default be guessed based on the closest data points. This member gives the default string representations used for each unit. For an overview of the replacement codes, see dateFormat.

      Defaults to: 

       {
            millisecond:"%A, %b %e, %H:%M:%S.%L",
            second:"%A, %b %e, %H:%M:%S",
            minute:"%A, %b %e, %H:%M",
            hour:"%A, %b %e, %H:%M",
            day:"%A, %b %e, %Y",
            week:"Week from %A, %b %e, %Y",
            month:"%B %Y",
            year:"%Y"
        }

    • getFollowPointer

      public Boolean getFollowPointer()
      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: false

    • getFollowTouchMove

      public Boolean getFollowTouchMove()
      See Also:

    • setFollowTouchMove

      public void setFollowTouchMove(Boolean followTouchMove)
      Whether the tooltip should follow the finger as it moves on a touch device. If this is true and chart.panning is set, followTouchMove will take over one-finger touches, so the user needs to use two fingers for zooming and panning.

      Defaults to: true

    • getFooterFormat

      public String getFooterFormat()
      See Also:

    • setFooterFormat

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

      Defaults to: false

    • getHeaderFormat

      public String getHeaderFormat()
      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.key, series.name, series.color and other members from the point and series objects. The point.key variable contains the category name, x value or datetime string depending on the type of axis. For datetime axes, the point.key date format can be set using tooltip.xDateFormat.

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

    • getHideDelay

      public Number getHideDelay()
      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

    • getPadding

      public Number getPadding()
      See Also:

    • setPadding

      public void setPadding(Number padding)
      Padding inside the tooltip, in pixels.

      Defaults to: 8

    • getPointFormat

      public String getPointFormat()
      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.x, point.y, series.name and series.color and other properties on the same form. Furthermore, point.y 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.

      In styled mode, the dot is colored by a class name rather than the point color.

      Defaults to: ● {series.name}: {point.y}

    • getPointFormatter

      public String getPointFormatter()

    • setPointFormatter

      public void setPointFormatter(String _fn_pointFormatter)

    • getSplit

      public Boolean getSplit()
      See Also:

    • setSplit

      public void setSplit(Boolean split)
      Split the tooltip into one label per series, with the header close to the axis. This is recommended over shared tooltips for charts with multiple line series, generally making them easier to read.

      Defaults to: false

    • getValueDecimals

      public Number getValueDecimals()
      See Also:

    • setValueDecimals

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

    • getValuePrefix

      public String getValuePrefix()
      See Also:

    • setValuePrefix

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

    • getValueSuffix

      public String getValueSuffix()
      See Also:

    • setValueSuffix

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

    • getXDateFormat

      public String getXDateFormat()
      See Also:

    • setXDateFormat

      public void setXDateFormat(String xDateFormat)
      The format for the date in the tooltip header if the X axis is a datetime axis. The default is a best guess based on the smallest distance between points in the chart.

    • getChangeDecimals

      public Number getChangeDecimals()
      See Also:

    • setChangeDecimals

      public void setChangeDecimals(Number changeDecimals)
      How many decimals to show for the point.change value when the series.compare option is set. This is overridable in each series' tooltip options object. The default is to preserve all decimals.

    • getShape

      public Shape getShape()
      See Also:

    • setShape

      public void setShape(Shape shape)
      The name of a symbol to use for the border around the tooltip. In Highstock 1.x, the shape was square.

      Defaults to: callout