com.github.highcharts4gwt.model.highcharts.option.api.seriesspline.Tooltip Maven / Gradle / Ivy
Show all versions of highcharts Show documentation
package com.github.highcharts4gwt.model.highcharts.option.api.seriesspline;
import com.github.highcharts4gwt.model.highcharts.option.api.seriesspline.PointFormatterCallback;
/**
* A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
*
*/
public interface Tooltip {
/**
* 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"
* }
*
*
*/
String 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"
* }
*
*
*/
Tooltip dateTimeLabelFormats(String dateTimeLabelFormatsAsJsonString);
/**
* 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.
*
*/
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.
*
*/
Tooltip followPointer(boolean followPointer);
/**
* Whether the tooltip should follow the finger as it moves on a touch device. If chart.zoomType is set, it will override followTouchMove.
*
*/
boolean followTouchMove();
/**
* Whether the tooltip should follow the finger as it moves on a touch device. If chart.zoomType is set, it will override followTouchMove.
*
*/
Tooltip followTouchMove(boolean followTouchMove);
/**
* A string to append to the tooltip format.
*
*/
String footerFormat();
/**
* A string to append to the tooltip format.
*
*/
Tooltip footerFormat(String footerFormat);
/**
* 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/>
*
*/
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/>
*
*/
Tooltip headerFormat(String headerFormat);
/**
* The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
*
*/
double hideDelay();
/**
* The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
*
*/
Tooltip hideDelay(double hideDelay);
/**
* 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.
*
*/
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.
*
*/
Tooltip pointFormat(String pointFormat);
/**
* A callback function for formatting the HTML output for a single point in the tooltip. Like the pointFormat string, but with more flexibility.
*
*/
Tooltip pointFormatter(PointFormatterCallback pointFormatter);
/**
* The name of a symbol to use for the border around the tooltip. In Highcharts 3.x and less, the shape was square.
*
*/
String shape();
/**
* The name of a symbol to use for the border around the tooltip. In Highcharts 3.x and less, the shape was square.
*
*/
Tooltip shape(String shape);
/**
* 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.
*
*/
double 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.
*
*/
Tooltip valueDecimals(double valueDecimals);
/**
* A string to prepend to each series' y value. Overridable in each series' tooltip options object.
*
*/
String valuePrefix();
/**
* A string to prepend to each series' y value. Overridable in each series' tooltip options object.
*
*/
Tooltip valuePrefix(String valuePrefix);
/**
* A string to append to each series' y value. Overridable in each series' tooltip options object.
*
*/
String valueSuffix();
/**
* A string to append to each series' y value. Overridable in each series' tooltip options object.
*
*/
Tooltip valueSuffix(String valueSuffix);
/**
* 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.
*
*/
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.
*
*/
Tooltip xDateFormat(String xDateFormat);
String getFieldAsJsonObject(String fieldName);
Tooltip setFieldAsJsonObject(String fieldName, String fieldValueAsJonObject);
String getFunctionAsString(String fieldName);
Tooltip setFunctionAsString(String fieldName, String functionAsString);
}