public class Tooltip extends BaseOption
Constructor and Description |
---|
Tooltip() |
Modifier and Type | Method and Description |
---|---|
Function |
formatter()
Callback function to format the text of the tooltip from scratch.
|
Tooltip |
formatter(Function formatter)
Callback function to format the text of the tooltip from scratch.
|
Function |
getFormatter()
Callback function to format the text of the tooltip from scratch.
|
Tooltip |
setFormatter(Function formatter)
Callback function to format the text of the tooltip from scratch.
|
set_hcNulledOption
public Function formatter()
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. 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.
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:
this.point.name
.this.series.name
.public Tooltip formatter(Function formatter)
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. 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.
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:
this.point.name
.this.series.name
.formatter
- the value for the formatter optionpublic Function getFormatter()
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. 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.
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:
this.point.name
.this.series.name
.public Tooltip setFormatter(Function formatter)
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. 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.
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:
this.point.name
.this.series.name
.formatter
- the value for the formatter optionCopyright © 2022. All rights reserved.