TooltipOptions (Fujion Wrapper for HighCharts 1.0.12 API)

java.lang.Object
- org.fujion.ancillary.Options
- - org.fujion.highcharts.TooltipOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter
```
public class TooltipOptions
extends Options
```
Options for tooltip rendering.

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`animation` Enable or disable animation of the tooltip.
`String`	`backgroundColor` The background color or gradient for the tooltip.
`String`	`borderColor` The color of the tooltip border.
`Integer`	`borderRadius` The radius of the rounded border corners.
`Integer`	`borderWidth` The pixel width of the tooltip border.
`Object`	`crosshairs` Display crosshairs to connect the points with their corresponding axis values.
`DateTimeFormatOptions`	`dateTimeLabelFormats` 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.
`Boolean`	`enabled` Enable or disable the tooltip.
`Boolean`	`followPointer` Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent.
`Boolean`	`followTouchMove` Whether the tooltip should follow the finger as it moves on a touch device.
`String`	`footerFormat` A string to append to the tooltip format.
`String`	`formatter` Callback function to format the text of the tooltip.
`String`	`headerFormat` Not sure if this is supported?
`Integer`	`hideDelay` The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
`String`	`pointFormat` The HTML of the point's line in the tooltip.
`String`	`positioner` A callback function to place the tooltip in a default position.
`Boolean`	`shadow` Whether to apply a drop shadow to the tooltip.
`Boolean`	`shared` When the tooltip is shared, the entire plot area will capture mouse movement, and tooltip texts for all series will be shown in a single bubble.
`Integer`	`snap` Proximity snap for graphs or single points.
`StyleOptions`	`style` CSS styles for the tooltip.
`Boolean`	`useHTML` Use HTML to render the contents of the tooltip instead of SVG.
`Integer`	`valueDecimals` How many decimals to show in each series' y value.
`String`	`valuePrefix` A string to prepend to each series' y value.
`String`	`valueSuffix` A string to append to each series' y value.

Constructor Summary

Constructors
Constructor and Description

TooltipOptions()

Constructors
Constructor and Description
`TooltipOptions()`

Method Summary
- Methods inherited from class org.fujion.ancillary.Options
  copyTo, toMap
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
 - animation
```
public Boolean animation
```
 Enable or disable animation of the tooltip. In old browsers combined with data-heavy charts, the animation may be slow, so turning it off can be a good idea. Defaults to true.
 - backgroundColor
```
public String backgroundColor
```
 The background color or gradient for the tooltip. Defaults to "rgba(255, 255, 255, .85)".
 - borderColor
```
public String borderColor
```
 The color of the tooltip border. When null, the border takes the color of the corresponding series or point. Defaults to "auto".
 - borderRadius
```
public Integer borderRadius
```
 The radius of the rounded border corners. Defaults to 5.
 - borderWidth
```
public Integer borderWidth
```
 The pixel width of the tooltip border. Defaults to 2.
 - crosshairs
```
public Object crosshairs
```
 Display crosshairs to connect the points with their corresponding axis values. The crosshairs can be defined as a boolean, an array of booleans or an object.
 - Boolean - If the crosshairs option is true, a single crosshair relating to the x axis will be shown.
 - Array of booleans - In an array of booleans, the first value turns on the x axis crosshair and the second value to the y axis crosshair. Use [true, true] to show complete crosshairs.
 - Array of objects - In an array of objects, the first value applies to the x axis crosshair and the second value to the y axis crosshair. For each dimension, a width, color, dashStyle and zIndex can be given.
 Defaults to null.
 - dateTimeLabelFormats
```
public final DateTimeFormatOptions dateTimeLabelFormats
```
 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.
 - enabled
```
public Boolean enabled
```
 Enable or disable the tooltip. Defaults to true.
 - followPointer
```
public Boolean followPointer
```
 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.
 - followTouchMove
```
public Boolean followTouchMove
```
 Whether the tooltip should follow the finger as it moves on a touch device. The default value of false causes a touch move to scroll the web page, as is default behaviour on touch devices. Setting it to true may cause the user to be trapped inside the chart and unable to scroll away, so it should be used with care. If chart.zoomType is set, it will override followTouchMove Defaults to false.
 - footerFormat
```
public String footerFormat
```
 A string to append to the tooltip format.
 - formatter
```
@JavaScript
public String formatter
```
 Callback function to format the text of the tooltip.
 - headerFormat
```
public String headerFormat
```
 Not sure if this is supported?
 - hideDelay
```
public Integer hideDelay
```
 The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart. Defaults to 500.
 - pointFormat
```
public String pointFormat
```
 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.yPrefix and tooltip.ySuffix variables. This can also be overridden for each series, which makes it a good hook for displaying units. Defaults to ● {series.name}: {point.y} 
 - positioner
```
@JavaScript
public String positioner
```
 A callback function to place the tooltip in a default position.
 - shadow
```
public Boolean shadow
```
 Whether to apply a drop shadow to the tooltip. Defaults to true.
 - shared
```
public Boolean shared
```
 When the tooltip is shared, the entire plot area will capture mouse movement, and tooltip texts for all series will be shown in a single bubble. This is recommended for single series charts and for iPad optimized sites. Defaults to false.
 - snap
```
public Integer snap
```
 Proximity snap for graphs or single points. Does not apply to bars, columns and pie slices. It defaults to 10 for mouse-powered devices and 25 for touch devices. Defaults to 10/25.
 - style
```
public final StyleOptions style
```
 CSS styles for the tooltip. The tooltip can also be styled through the CSS class .highcharts-tooltip. Default value:
```
 style: {
 color: '#333333',
 fontSize: '9pt',
 padding: '5px'
 }
 
```
 - useHTML
```
public Boolean useHTML
```
 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. Defaults to false.
 - valueDecimals
```
public Integer valueDecimals
```
 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.
 - valuePrefix
```
public String valuePrefix
```
 A string to prepend to each series' y value. Overridable in each series' tooltip options object. Defaults to "".
 - valueSuffix
```
public String valueSuffix
```
 A string to append to each series' y value. Overridable in each series' tooltip options object. Defaults to "".
- Constructor Detail
 - TooltipOptions
```
public TooltipOptions()
```

Class TooltipOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.ancillary.Options

Methods inherited from class java.lang.Object

Field Detail

animation

backgroundColor

borderColor

borderRadius

borderWidth

crosshairs

dateTimeLabelFormats

enabled

followPointer

followTouchMove

footerFormat

formatter

headerFormat

hideDelay

pointFormat

positioner

shadow

shared

snap

style

useHTML

valueDecimals

valuePrefix

valueSuffix

Constructor Detail

TooltipOptions