Tooltip

Companion object Tooltip

class Tooltip extends Object

Annotations: @RawJSType() @ScalaJSDefined()
Note: JavaScript name: tooltip

Linear Supertypes

Object, Any, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Tooltip
Object
Any
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Tooltip()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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
2.3.0
final def asInstanceOf[T0]: T0

Definition Classes
Any
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. Yellowish background. Gradient. Tooltip in styled mode.
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. Follow series by default, black border
val borderRadius: UndefOr[Double]
The radius of the rounded border corners.
The radius of the rounded border corners.
Example:
1. 5px by default, square borders
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. 2px by default. No border (shadow only). Tooltip in styled mode.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val crosshairs: Any
Since 4.1, the crosshair definitions are moved to the Axis object in order for a better separation from the tooltip.
Since 4.1, the crosshair definitions are moved to the Axis object in order for a better separation from the tooltip. See xAxis.crosshair .
Example:
1. Enable a crosshair for the x value.
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"
}
```
val enabled: UndefOr[Boolean]
Enable or disable the tooltip.
Enable or disable the tooltip.
Example:
1. Disabled, disable tooltip and show values on chart instead.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
3.0
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
3.0.1
val footerFormat: UndefOr[String]
A string to append to the tooltip format.
A string to append to the tooltip format.
Example:
1. A table for value alignment
Since
2.2
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. The HTML of the tooltip is parsed and converted to SVG, therefore this isn't a complete HTML renderer. The following tags are supported: , , , ,  , . 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.
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. Simple string formatting, formatting with shared tooltip
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
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 {point.key} 
Example:
1. A HTML table in the tooltip
val hideDelay: UndefOr[Double]
The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.

Since
3.0
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val padding: UndefOr[Double]
Padding inside the tooltip, in pixels.
Padding inside the tooltip, in pixels.

Since
5.0.0
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, 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.
Example:
1. A different point format with value suffix
Since
2.2
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
4.1.0
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
Since
2.2.4
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val shadow: UndefOr[Boolean]
Whether to apply a drop shadow to the tooltip.
Whether to apply a drop shadow to the tooltip.
Example:
1. True by default, false
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 Highcharts 3.x and less, the shape was square.

Since
4.0
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.
Example:
1. False by default, true, true with x axis crosshair, true with mixed series types.
Since
2.1
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.
Example:
1. 10 px by default, 50 px on graph
Since
1.2.0
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
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.
Example:
1. Greater padding, bold text
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
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
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
2.2
def valueOf(): Any

Definition Classes
Object
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
2.2
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
2.2
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val xDateFormat: UndefOr[String]
The format for the date in the tooltip header if the X axis is a datetime axis.
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.
Example:
1. A different format

Packages

Tooltip

Companion object Tooltip

class Tooltip extends Object

Instance Constructors

Value Members

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Tooltip 

Companion object Tooltip

class Tooltip extends Object

Instance Constructors

Value Members

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped

Tooltip