org.fujion.highcharts

Class TooltipOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.TooltipOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

Direct Known Subclasses:

GlobalTooltipOptions

public class TooltipOptions
extends Options

Options for tooltip rendering.

Field Summary

Fields

Modifier and Type	Field and Description
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	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	headerFormat The HTML of the tooltip header line.
Integer	hideDelay The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
Integer	padding Padding inside the tooltip, in pixels.
String	pointerFormatter A callback function for formatting the HTML output for a single point in the tooltip.
String	pointFormat The HTML of the point's line in the tooltip.
Boolean	split Split the tooltip into one label per series, with the header close to the axis.
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.
String	xDateFormat The format for the date in the tooltip header if the X axis is a datetime axis.

Constructor Summary

Constructors

Constructor and Description
TooltipOptions()

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

dateTimeLabelFormats

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

followPointer

@Option
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. Defaults to undefined.

followTouchMove

@Option
public Boolean followTouchMove

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. Defaults to undefined.

footerFormat

@Option
public String footerFormat

A string to append to the tooltip format. Defaults to "".

headerFormat

@Option
public String headerFormat

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 <span style="font-size: 10px">{point.key}</span><br/>.

hideDelay

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

padding

@Option
public Integer padding

Padding inside the tooltip, in pixels. Defaults to 8.

pointFormat

@Option
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.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. Defaults to <span style="color:{point.color}">●</span> {series.name}: <b>{point.y}</b><br/>.

pointerFormatter

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

A callback function for formatting the HTML output for a single point in the tooltip. Like the pointFormat string, but with more flexibility. Defaults to undefined.

split

@Option
public Boolean split

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. This option takes precedence over tooltip.shared. Defaults to undefined.

valueDecimals

@Option
public Integer valueDecimals

How many decimals to show in each series' y value. This may be overridden in each series' tooltip options object. The default is to preserve all decimals. Defaults to undefined.

valuePrefix

@Option
public String valuePrefix

A string to prepend to each series' y value. Overridable in each series' tooltip options object. Defaults to undefined.

valueSuffix

@Option
public String valueSuffix

A string to append to each series' y value. Overridable in each series' tooltip options object. Defaults to undefined.

xDateFormat

@Option
public String xDateFormat

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. Defaults to undefined.

Constructor Detail

TooltipOptions

public TooltipOptions()