Inherits BaseObject.
|
| Animation | Animation [get, set] |
| | Enable or disable animation of the tooltip. More...
|
| |
| string | BackgroundColor [get, set] |
| | The background color or gradient for the tooltip.In styled mode, the stroke width is set in the<tt>.highcharts-tooltip-box class. More...
|
| |
| string | BorderColor [get, set] |
| | The color of the tooltip border. When undefined, the border takesthe color of the corresponding series or point.Note that the borderWidth is usually 0 bydefault, so the border color may not be visible until a border widthis set. More...
|
| |
| double | BorderRadius [get, set] |
| | The radius of the rounded border corners. More...
|
| |
| double | BorderWidth [get, set] |
| | The pixel width of the tooltip border. Defaults to 0 for singletooltips and 1 for split tooltips.In styled mode, the stroke width is set in the<tt>.highcharts-tooltip-box class. More...
|
| |
| string | ClassName [get, set] |
| | A CSS class name to apply to the tooltip's container div,allowing unique CSS styling for each chart. More...
|
| |
| string | ClusterFormat [get, set] |
| | The HTML of the cluster point's in the tooltip. Works only withmarker-clusters module and analogously topointFormat.The cluster tooltip can be also formatted usingtooltip.formatter callback function and point.isCluster flag. More...
|
| |
| List< Crosshair > | Crosshairs [get, set] |
| | Since 4.1, the crosshair definitions are moved to the Axis objectin order for a better separation from the tooltip. SeexAxis.crosshair. More...
|
| |
| Hashtable | DateTimeLabelFormats [get, set] |
| | For series on datetime axes, the date format in the tooltip'sheader will by default be guessed based on the closest data points.This member gives the default string representations used foreach unit. For an overview of the replacement codes, seedateFormat. More...
|
| |
| double | Distance [get, set] |
| | Distance from point to tooltip in pixels. More...
|
| |
| bool | Enabled [get, set] |
| | Enable or disable the tooltip. More...
|
| |
| bool | FollowPointer [get, set] |
| | Whether the tooltip should follow the mouse as it moves acrosscolumns, pie slices and other point types with an extent.By default it behaves this way for pie, polygon, map, sankeyand wordcloud series by override in the plotOptionsfor those series types.Does not apply if split is true.For touch moves to behave the same way, followTouchMove must be true also. More...
|
| |
| bool | FollowTouchMove [get, set] |
| | Whether the tooltip should update as the finger moves on a touchdevice. If this is true and chart.panning isset,followTouchMove will take over one-finger touches, so the userneeds to use two fingers for zooming and panning.Note the difference to followPointer thatonly defines the position of the tooltip. If followPointer isfalse in for example a column series, the tooltip will show above orbelow the column, but as followTouchMove is true, the tooltip willjump from column to column as the user swipes across the plot area. More...
|
| |
| string | FooterFormat [get, set] |
| | A string to append to the tooltip format. More...
|
| |
| string | Format [get, set] |
| | A format stringfor the whole tooltip. When format strings are a requirement, it isusually more convenient to use headerFormat, pointFormat andfooterFormat, but the format option allows combining them intoone setting.The context of the format string is the same as that of theformatter callback. More...
|
| |
| string | Formatter [get, set] |
| | Callback function to format the text of the tooltip from scratch. Incase of single or shared tooltips, a string shouldbe returned. In case of split tooltips, it shouldreturn an array where the first item is the header, and subsequentitems are mapped to the points. Return false to disable tooltip fora specific point on series.A subset of HTML is supported. Unless useHTML is true, the HTML ofthe tooltip is parsed and converted to SVG, therefore this isn't acomplete HTML renderer. The following HTML tags are supported: b,br, em, i, span, strong. Spans can be styled with a styleattribute, but only text-related CSS, that is shared with SVG, ishandled.The available data in the formatter differ a bit depending on whetherthe tooltip is shared or split, or belongs to a single point. In ashared/split tooltip, all properties except x, which is common forall points, are kept in an array, this.points.Available data are:- this.percentage (not shared) / this.points[i].percentage (shared): Stacked series and pies only. The point's percentage of the total.- this.point (not shared) / this.points[i].point (shared): The point object. The point name, if defined, is available through this.point.name.- this.points: In a shared tooltip, this is an array containing all other properties for each point.- this.series (not shared) / this.points[i].series (shared): The series object. The series name is available through this.series.name.- this.total (not shared) / this.points[i].total (shared): Stacked series only. The total value at this point's x value.- this.x: The x value. This property is the same regardless of the tooltip being shared or not.- this.y (not shared) / this.points[i].y (shared): The y value. More...
|
| |
| string | HeaderFormat [get, set] |
| | The HTML of the tooltip header line. Variables are enclosed bycurly brackets. Available variables are point.key, series.name,series.color and other members from the point and seriesobjects. The point.key variable contains the category name, xvalue or datetime string depending on the type of axis. For datetimeaxes, the point.key date format can be set usingtooltip.xDateFormat. More...
|
| |
| TooltipHeaderShape | HeaderShape [get, set] |
| | The name of a symbol to use for the border around the tooltipheader. Applies only when tooltip.split isenabled.Custom callbacks for symbol path generation can also be added toHighcharts.SVGRenderer.prototype.symbols the same way as forseries.marker.symbol. More...
|
| |
| double | HideDelay [get, set] |
| | The number of milliseconds to wait until the tooltip is hidden whenmouse out from a point or chart. More...
|
| |
| string | NullFormat [get, set] |
| | The HTML of the null point's line in the tooltip. Works analogouslyto pointFormat. More...
|
| |
| string | NullFormatter [get, set] |
| | Callback function to format the text of the tooltip forvisible null points.Works analogously to formatter. More...
|
| |
| bool | Outside [get, set] |
| | Whether to allow the tooltip to render outside the chart's SVGelement box. By default (false), the tooltip is rendered within thechart's SVG element, which results in the tooltip being alignedinside the chart area. For small charts, this may result in clippingor overlapping. When true, a separate SVG element is created andoverlaid on the page, allowing the tooltip to be aligned inside thepage itself.Defaults to true if chart.scrollablePlotArea is activated,otherwise false. More...
|
| |
| double | Padding [get, set] |
| | Padding inside the tooltip, in pixels. More...
|
| |
| string | PointFormat [get, set] |
| | The HTML of the point's line in the tooltip. Variables are enclosedby curly brackets. Available variables are point.x, point.y,series.name and series.color and other properties on the sameform. Furthermore, point.y can be extended by thetooltip.valuePrefix and tooltip.valueSuffix variables. This canalso be overridden for each series, which makes it a good hook fordisplaying units.In styled mode, the dot is colored by a class name ratherthan the point color. More...
|
| |
| string | PointFormatter [get, set] |
| | A callback function for formatting the HTML output for a single pointin the tooltip. Like the pointFormat string, but with moreflexibility. More...
|
| |
| string | Positioner [get, set] |
| | A callback function to place the tooltip in a custom position. Thecallback receives three parameters: labelWidth, labelHeight andpoint, where point contains values for plotX and plotY tellingwhere the reference point is in the plot area. Add chart.plotLeftand chart.plotTop to get the full coordinates.To find the actual hovered Point instance, usethis.chart.hoverPoint. For shared or split tooltips, all the hoverpoints are available in this.chart.hoverPoints.Since v7, when tooltip.split option is enabled,positioner is called for each of the boxes separately, includingxAxis header. xAxis header is not a point, instead point argumentcontains info: { plotX: Number, plotY: Number, isHeader: Boolean }The return should be an object containing x and y values, for example{ x: 100, y: 100 }. More...
|
| |
| Shadow | Shadow [get, set] |
| | Whether to apply a drop shadow to the tooltip. More...
|
| |
| bool | ShadowBool [get, set] |
| | Whether to apply a drop shadow to the tooltip. More...
|
| |
| string | Shape [get, set] |
| | The name of a symbol to use for the border around the tooltip. Canbe one of: "callout", "circle" or "rect". Whentooltip.splitoption is enabled, shape is applied to all boxes except header, whichis controlled bytooltip.headerShape.Custom callbacks for symbol path generation can also be added toHighcharts.SVGRenderer.prototype.symbols the same way as forseries.marker.symbol. More...
|
| |
| bool | Shared [get, set] |
| | When the tooltip is shared, the entire plot area will capture mousemovement or touch events. Tooltip texts for series types with ordereddata (not pie, scatter, flags etc) will be shown in a single bubble.This is recommended for single series charts and for tablet/mobileoptimized charts.See also tooltip.split, that is better suited forcharts with many series, especially line-type series. Thetooltip.split option takes precedence over tooltip.shared. More...
|
| |
| double | Snap [get, set] |
| | Proximity snap for graphs or single points. It defaults to 10 formouse-powered devices and 25 for touch devices.Note that in most cases the whole plot area captures the mousemovement, and in these cases tooltip.snap doesn't make sense. Thisapplies when stickyTrackingis true (default) and when the tooltip is sharedor split. More...
|
| |
| bool | Split [get, set] |
| | Split the tooltip into one label per series, with the header closeto the axis. This is recommended over sharedtooltips for charts with multiple line series, generally making themeasier to read. This option takes precedence over tooltip.shared.Not supported for polar and inverted charts. More...
|
| |
| bool | StickOnContact [get, set] |
| | Prevents the tooltip from switching or closing when touched orpointed. More...
|
| |
| Hashtable | Style [get, set] |
| | CSS styles for the tooltip. The tooltip can also be styled throughthe CSS class .highcharts-tooltip.Note that the default pointerEvents style makes the tooltip ignoremouse events, so in order to use clickable tooltips, this value mustbe set to auto. More...
|
| |
| bool | UseHTML [get, set] |
| | Use HTML to render the contents of the tooltip instead of SVG. UsingHTML allows advanced formatting like tables and images in thetooltip. It is also recommended for rtl languages as it works aroundrtl bugs in early Firefox. More...
|
| |
| double | ValueDecimals [get, set] |
| | How many decimals to show in each series' y value. This isoverridable in each series' tooltip options object. The default is topreserve all decimals. More...
|
| |
| string | ValuePrefix [get, set] |
| | A string to prepend to each series' y value. Overridable in eachseries' tooltip options object. More...
|
| |
| string | ValueSuffix [get, set] |
| | A string to append to each series' y value. Overridable in eachseries' tooltip options object. More...
|
| |
| string | XDateFormat [get, set] |
| | The format for the date in the tooltip header if the X axis is adatetime axis. The default is a best guess based on the smallestdistance between points in the chart. More...
|
| |
|
Hashtable | CustomFields [get, set] |
| |
1.8.14