Tooltip

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. val animation: UndefOr[Boolean]

   

   Enable or disable animation of the tooltip.

   Enable or disable animation of the tooltip. In slow legacy IE browsers the animation is disabled by default.

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. val backgroundColor: UndefOr[|[String, Object]]

   

   The background color or gradient for the tooltip.

   The background color or gradient for the tooltip.

   In styled mode, the stroke width is set in the .highcharts-tooltip-box class.

   Example:

   1. Background and border demo. Tooltip in styled mode.

7. val borderColor: UndefOr[|[String, Object]]

   

   The color of the tooltip border.

   The color of the tooltip border. When null, the border takes the color of the corresponding series or point.

   Example:

   1. Background and border demo

8. val borderRadius: UndefOr[Double]

   

   The radius of the rounded border corners.

   The radius of the rounded border corners.

   Example:

   1. Background and border demo

9. val borderWidth: UndefOr[Double]

   

   The pixel width of the tooltip border.

   The pixel width of the tooltip border.

   In styled mode, the stroke width is set in the .highcharts-tooltip-box class.

   Example:

   1. Background and border demo. Tooltip in styled mode.

10. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11. val crosshairs: Any

    

    Since 1.1, the crosshair definitions are moved to the Axis object in order for a better separation from the tooltip.

    Since 1.1, the crosshair definitions are moved to the Axis object in order for a better separation from the tooltip. See xAxis.crosshair.

12. val enabled: UndefOr[Boolean]

    

    Enable or disable the tooltip.

13. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

14. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

15. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

16. val followPointer: UndefOr[Boolean]

    

    Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent.

    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.

17. val followTouchMove: UndefOr[Boolean]

    

    Whether the tooltip should follow the finger as it moves on a touch device.

    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.

18. val footerFormat: UndefOr[String]

    

    A string to append to the tooltip format.

    A string to append to the tooltip format.

    Example:

    1. Format demo

19. val formatter: UndefOr[Function]

    

    Callback function to format the text of the tooltip.

    Callback function to format the text of the tooltip. Return false to disable tooltip for a specific point on series.

    A subset of HTML is supported. Unless useHTML is true, the HTML of the tooltip is parsed and converted to SVG, therefore this isn't a complete HTML renderer. The following tags are supported: <b>, <strong>, <i>, <em>, <br/>, <span>. Spans can be styled with a style attribute, but only text-related CSS that is shared with SVG is handled.

    Available data are: <dl>

    <dt>this.point</dt>

    The point object. The point name, if defined, is available through this.point.name, and the value through this.point.value.

    <dt>this.series</dt>

    The series object. The series name is available through this.series.name.

    </dl>

    Example:

    1. String formatting

20. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

21. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

22. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

23. val headerFormat: UndefOr[String]

    

    The HTML of the tooltip header line.

    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/>

    Example:

    1. Format demo

24. val hideDelay: UndefOr[Double]

    

    The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.

25. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

26. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

27. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

28. final def notify(): Unit

    

    Definition Classes

    AnyRef

29. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

30. val padding: UndefOr[Double]

    

    Padding inside the tooltip, in pixels.

    Padding inside the tooltip, in pixels.

    Since

    5.0.0

31. val pointFormat: UndefOr[String]

    

    The HTML of the point's line in the tooltip.

    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/>'

    Example:

    1. Format demo

32. val pointFormatter: UndefOr[Function]

    

    A callback function for formatting the HTML output for a single point in the tooltip.

    A callback function for formatting the HTML output for a single point in the tooltip. Like the pointFormat string, but with more flexibility.

    Since

    1.1.0

33. val positioner: UndefOr[Function]

    

    A callback function to place the tooltip in a default position.

    A callback function to place the tooltip in a default position. The callback receives three parameters: labelWidth, labelHeight and point, where point contains values for plotX and plotY telling where the reference point is in the plot area. Add chart.plotLeft and chart.plotTop to get the full coordinates.

    The return should be an object containing x and y values, for example { x: 100, y: 100 }.

    Example:

    1. A fixed tooltip position

34. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

35. val shadow: UndefOr[Boolean]

    

    Whether to apply a drop shadow to the tooltip.

    Whether to apply a drop shadow to the tooltip.

    Example:

    1. Fixed tooltip position, border and shadow disabled

36. val split: UndefOr[Boolean]

    

    Split the tooltip into one label per series, with the header close to the axis.

    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.

    Example:

    1. Split tooltip

    Since

    5.0.0

37. val style: UndefOr[Object]

    

    CSS styles for the tooltip.

    CSS styles for the tooltip. The tooltip can also be styled through the CSS class .highcharts-tooltip.

38. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

39. def toLocaleString(): String

    

    Definition Classes

    Object

40. def toString(): String

    

    Definition Classes

    AnyRef → Any

41. val useHTML: UndefOr[Boolean]

    

    Use HTML to render the contents of the tooltip instead of SVG.

    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.

    Example:

    1. Pure HTML tooltip

42. val valueDecimals: UndefOr[Double]

    

    How many decimals to show in each series' value.

    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.

    Example:

    1. Set decimals, prefix and suffix for the value

43. def valueOf(): Any

    

    Definition Classes

    Object

44. val valuePrefix: UndefOr[String]

    

    A string to prepend to each series' value.

    A string to prepend to each series' value. Overridable in each series' tooltip options object.

    Example:

    1. Set decimals, prefix and suffix for the value

45. val valueSuffix: UndefOr[String]

    

    A string to append to each series' value.

    A string to append to each series' value. Overridable in each series' tooltip options object.

    Example:

    1. Set decimals, prefix and suffix for the value

46. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

47. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

48. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )