Packages

class Tooltip extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: tooltip

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tooltip
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new 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.

    Since

    1.2.0

  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. Custom tooltip. 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. Styled tooltip

  8. val borderRadius: UndefOr[Double]

    The radius of the rounded border corners.

  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. Custom tooltip. Tooltip in styled mode.

  10. val changeDecimals: UndefOr[Double]

    How many decimals to show for the point.change value when the series.compare option is set.

    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.

    Since

    1.0.1

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val crosshairs: Any

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

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

  13. val dateTimeLabelFormats: UndefOr[Object]

    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.

    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"
}

  14. val enabled: UndefOr[Boolean]

    Enable or disable the tooltip.

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. 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.

    Since

    1.3

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

    Since

    1.3.1

  20. val formatter: UndefOr[Function]

    Callback function to format the text of the tooltip from scratch.

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

    A subset of HTML is supported. 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.

    Since version 2.1 the tooltip can be shared between multiple series through the shared option. The available data in the formatter differ a bit depending on whether the tooltip is shared or not. In a shared tooltip, all properties except x, which is common for all points, are kept in an array, this.points. Another feature that affects what properties are available, is dataGrouping.

    Available data are: <dl> <dt>this.percentage (not shared) / this.points[i].percentage (shared)</dt>

    Stacked series and pies only. The point's percentage of the total.
    <dt>this.point (not shared) / this.points[i].point (shared)</dt>
    The point object. The point name, if defined, is available through this.point.name.
    <dt>this.points</dt>
    In a shared tooltip, this is an array containing all other properties for each point.
    <dt>this.series (not shared) / this.points[i].series (shared)</dt>
    The series object. The series name is available through this.series.name.
    <dt>this.total (not shared) / this.points[i].total (shared)</dt>
    Stacked series only. The total value at this point's x value.
    <dt>this.x</dt>
    The x value. This property is the same regardless of the tooltip being shared or not.
    <dt>this.y (not shared) / this.points[i].y (shared)</dt>
    The y value.
    </dl>

    Example:

    1. formatting with shared tooltip

  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  22. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  24. 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.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/>

    Example:

    1. A HTML table in the tooltip

  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.x, point.y, point.change, 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.

  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

    2.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 on top of the chart

    Since

    1.1.5

  34. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  35. val shadow: UndefOr[Boolean]

    Whether to apply a drop shadow to the tooltip.

  36. val shape: UndefOr[String]

    The name of a symbol to use for the border around the tooltip.

    The name of a symbol to use for the border around the tooltip. In Highstock 1.x, the shape was square.

    Since

    2.0

  37. val shared: UndefOr[Boolean]

    When the tooltip is shared, the entire plot area will capture mouse movement or touch events.

    When the tooltip is shared, the entire plot area will capture mouse movement or touch events. Tooltip texts for series types with ordered data (not pie, scatter, flags etc) will be shown in a single bubble. This is recommended for single series charts and for tablet/mobile optimized charts.

    See also tooltip.split, that is better suited for charts with many series, especially line-type series.

  38. val snap: UndefOr[Double]

    Proximity snap for graphs or single points.

    Proximity snap for graphs or single points. It defaults to 10 for mouse-powered devices and 25 for touch devices.

    Note that in most cases the whole plot area captures the mouse movement, and in these cases tooltip.snap doesn't make sense. This applies when stickyTracking is true (default) and when the tooltip is shared or split.

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

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

  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. def toLocaleString(): String
    Definition Classes
    Object
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. 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. A table for value alignment. Full HTML tooltip.

    Since

    2.2

  45. val valueDecimals: UndefOr[Double]

    How many decimals to show in each series' y value.

    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.

    Example:

    1. Set decimals, prefix and suffix for the value

    Since

    1.2

  46. def valueOf(): Any
    Definition Classes
    Object
  47. val valuePrefix: UndefOr[String]

    A string to prepend to each series' y value.

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

    Example:

    1. Set decimals, prefix and suffix for the value

    Since

    1.2

  48. val valueSuffix: UndefOr[String]

    A string to append to each series' y value.

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

    Example:

    1. Set decimals, prefix and suffix for the value

    Since

    1.2

  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. val xDateFormat: UndefOr[String]

    The format for the date in the tooltip header.

    The format for the date in the tooltip header. If data grouping is used, the default is a smart guess based on how close the closest points are. It is pulled from the #plotOptions.dataGrouping.dateTimeLabelFormats array.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped