org.fujion.highcharts

Class GlobalTooltipOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.TooltipOptions

org.fujion.highcharts.GlobalTooltipOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class GlobalTooltipOptions
extends TooltipOptions

Global 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.
Boolean	enabled Enable or disable the tooltip.
String	formatter Callback function to format the text of 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.
String	shape The name of a symbol to use for the border around 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.

Fields inherited from class org.fujion.highcharts.TooltipOptions

dateTimeLabelFormats, followPointer, followTouchMove, footerFormat, headerFormat, hideDelay, padding, pointerFormatter, pointFormat, split, valueDecimals, valuePrefix, valueSuffix, xDateFormat

Constructor Summary

Constructors

Constructor and Description
GlobalTooltipOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

animation

@Option
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

@Option
public String backgroundColor

The background color or gradient for the tooltip. Defaults to "rgba(255, 255, 255, .85)".

borderColor

@Option
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

@Option
public Integer borderRadius

The radius of the rounded border corners. Defaults to 5.

borderWidth

@Option
public Integer borderWidth

The pixel width of the tooltip border. Defaults to 2.

crosshairs

@Option
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.

enabled

@Option
public Boolean enabled

Enable or disable the tooltip. Defaults to true.

formatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String formatter

Callback function to format the text of the tooltip.

positioner

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String positioner

A callback function to place the tooltip in a default position.

shadow

@Option
public Boolean shadow

Whether to apply a drop shadow to the tooltip. Defaults to true.

shape

@Option
public String shape

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

shared

@Option
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

@Option
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

@Option
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

@Option
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.

Constructor Detail

GlobalTooltipOptions

public GlobalTooltipOptions()