public class HITooltip extends HIFoundation
| Constructor and Description |
|---|
HITooltip() |
| Modifier and Type | Method and Description |
|---|---|
void |
defaultFormatter(HITooltip tooltip)
In case no user defined formatter is given, this will be used.
|
void |
destroy()
Removes and destroys the tooltip and its elements.
|
java.lang.Boolean |
getAnimation() |
HIColor |
getBackgroundColor() |
HIColor |
getBorderColor() |
java.lang.Number |
getBorderRadius() |
java.lang.Number |
getBorderWidth() |
java.lang.String |
getClassName() |
java.lang.String |
getClusterFormat() |
HIDateTimeLabelFormats |
getDateTimeLabelFormats() |
java.lang.Number |
getDistance() |
java.lang.Boolean |
getEnabled() |
java.lang.Boolean |
getFollowPointer() |
java.lang.Boolean |
getFollowTouchMove() |
java.lang.String |
getFooterFormat() |
java.lang.String |
getFormat() |
HIFunction |
getFormatter() |
java.lang.String |
getHeaderFormat() |
java.lang.String |
getHeaderShape() |
java.lang.Number |
getHideDelay() |
void |
getLabel()
Creates the Tooltip label element if it does not exist.
|
java.lang.String |
getLinkFormat() |
java.lang.String |
getNodeFormat() |
HIFunction |
getNodeFormatter() |
java.lang.String |
getNullFormat() |
HIFunction |
getNullFormatter() |
java.lang.Boolean |
getOutside() |
java.lang.Number |
getPadding() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
java.lang.String |
getPointFormat() |
HIFunction |
getPointFormatter() |
HIFunction |
getPositioner() |
HIShadowOptionsObject |
getShadow() |
java.lang.String |
getShape() |
java.lang.Boolean |
getShared() |
java.lang.Number |
getSnap() |
java.lang.Boolean |
getSplit() |
java.lang.Boolean |
getStickOnContact() |
HICSSObject |
getStyle() |
java.lang.Boolean |
getUseHTML() |
java.lang.Number |
getValueDecimals() |
java.lang.String |
getValuePrefix() |
java.lang.String |
getValueSuffix() |
java.lang.String |
getXDateFormat() |
void |
hide()
Hides the tooltip with a fade out animation.
|
void |
hide(java.lang.Number delay)
Hides the tooltip with a fade out animation.
|
void |
refreshByPoint(HIPoint point)
Refresh the tooltip's text and position.
|
void |
refreshByPoints(java.util.ArrayList<HIPoint> points)
Refresh the tooltip's text and position.
|
void |
setAnimation(java.lang.Boolean animation)
Enable or disable animation of the tooltip.
|
void |
setBackgroundColor(HIColor backgroundColor)
The background color or gradient for the tooltip.
|
void |
setBorderColor(HIColor borderColor)
The color of the tooltip border.
|
void |
setBorderRadius(java.lang.Number borderRadius)
The radius of the rounded border corners.
|
void |
setBorderWidth(java.lang.Number borderWidth)
The pixel width of the tooltip border.
|
void |
setClassName(java.lang.String className)
A CSS class name to apply to the tooltip's container div, allowing unique CSS styling for each chart.
|
void |
setClusterFormat(java.lang.String clusterFormat)
The HTML of the cluster point's in the tooltip.
|
void |
setDateTimeLabelFormats(HIDateTimeLabelFormats dateTimeLabelFormats)
For series on datetime axes, the date format in the tooltip's header will by defaults be guessed based on the closest data points.
|
void |
setDistance(java.lang.Number distance)
Distance from point to tooltip in pixels.
|
void |
setEnabled(java.lang.Boolean enabled)
Enable or disable the tooltip.
|
void |
setFollowPointer(java.lang.Boolean followPointer)
Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent.
|
void |
setFollowTouchMove(java.lang.Boolean followTouchMove)
Whether the tooltip should update as the finger moves on a touch device.
|
void |
setFooterFormat(java.lang.String footerFormat)
A string to append to the tooltip format.
|
void |
setFormat(java.lang.String format)
A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) for the whole tooltip.
|
void |
setFormatter(HIFunction formatter)
Callback function to format the text of the tooltip from scratch.
|
void |
setHeaderFormat(java.lang.String headerFormat)
The HTML of the tooltip header line.
|
void |
setHeaderShape(java.lang.String headerShape)
The name of a symbol to use for the border around the tooltip header.
|
void |
setHideDelay(java.lang.Number hideDelay)
The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
|
void |
setLinkFormat(java.lang.String linkFormat)
The HTML of the point's line in the tooltip.
|
void |
setNodeFormat(java.lang.String nodeFormat) |
void |
setNodeFormatter(HIFunction nodeFormatter)
A callback for defining the format for _nodes_ in the chart's tooltip, as opposed to links.
|
void |
setNullFormat(java.lang.String nullFormat)
The HTML of the null point's line in the tooltip.
|
void |
setNullFormatter(HIFunction nullFormatter)
Callback function to format the text of the tooltip for visible null points.
|
void |
setOutside(java.lang.Boolean outside)
Whether to allow the tooltip to render outside the chart's SVG element box.
|
void |
setPadding(java.lang.Number padding)
Padding inside the tooltip, in pixels.
|
void |
setPointFormat(java.lang.String pointFormat)
The HTML of the point's line in the tooltip.
|
void |
setPointFormatter(HIFunction pointFormatter)
A callback function for formatting the HTML output for a single point in the tooltip.
|
void |
setPositioner(HIFunction positioner)
A callback function to place the tooltip in a custom position.
|
void |
setShadow(HIShadowOptionsObject shadow)
Whether to apply a drop shadow to the tooltip.
|
void |
setShape(java.lang.String shape)
The name of a symbol to use for the border around the tooltip.
|
void |
setShared(java.lang.Boolean shared)
When the tooltip is shared, the entire plot area will capture mouse movement or touch events.
|
void |
setSnap(java.lang.Number snap)
Proximity snap for graphs or single points.
|
void |
setSplit(java.lang.Boolean split)
Split the tooltip into one label per series, with the header close to the axis.
|
void |
setStickOnContact(java.lang.Boolean stickOnContact)
Prevents the tooltip from switching or closing when touched or pointed.
|
void |
setStyle(HICSSObject style)
CSS styles for the tooltip.
|
void |
setUseHTML(java.lang.Boolean useHTML)
Use HTML to render the contents of the tooltip instead of SVG.
|
void |
setValueDecimals(java.lang.Number valueDecimals)
How many decimals to show in each series' y value.
|
void |
setValuePrefix(java.lang.String valuePrefix)
A string to prepend to each series' y value.
|
void |
setValueSuffix(java.lang.String valueSuffix)
A string to append to each series' y value.
|
void |
setXDateFormat(java.lang.String xDateFormat)
The format for the date in the tooltip header if the X axis is a datetime axis.
|
void |
update(HITooltip options)
Updates the tooltip with the provided tooltip options.
|
public void defaultFormatter(HITooltip tooltip)
tooltip - Tooltippublic void destroy()
public java.lang.Boolean getAnimation()
public HIColor getBackgroundColor()
public HIColor getBorderColor()
public java.lang.Number getBorderRadius()
public java.lang.Number getBorderWidth()
public java.lang.String getClassName()
public java.lang.String getClusterFormat()
public HIDateTimeLabelFormats getDateTimeLabelFormats()
public java.lang.Number getDistance()
public java.lang.Boolean getEnabled()
public java.lang.Boolean getFollowPointer()
public java.lang.Boolean getFollowTouchMove()
public java.lang.String getFooterFormat()
public java.lang.String getFormat()
public HIFunction getFormatter()
public java.lang.String getHeaderFormat()
public java.lang.String getHeaderShape()
public java.lang.Number getHideDelay()
public void getLabel()
public java.lang.String getLinkFormat()
public java.lang.String getNodeFormat()
public HIFunction getNodeFormatter()
public java.lang.String getNullFormat()
public HIFunction getNullFormatter()
public java.lang.Boolean getOutside()
public java.lang.Number getPadding()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams in class HIFoundationpublic java.lang.String getPointFormat()
public HIFunction getPointFormatter()
public HIFunction getPositioner()
public HIShadowOptionsObject getShadow()
public java.lang.String getShape()
public java.lang.Boolean getShared()
public java.lang.Number getSnap()
public java.lang.Boolean getSplit()
public java.lang.Boolean getStickOnContact()
public HICSSObject getStyle()
public java.lang.Boolean getUseHTML()
public java.lang.Number getValueDecimals()
public java.lang.String getValuePrefix()
public java.lang.String getValueSuffix()
public java.lang.String getXDateFormat()
public void hide()
public void hide(java.lang.Number delay)
delay - The fade out in milliseconds. If no value is provided the value of the tooltip.hideDelay option is used. A value of 0 disables the fade out animation.public void refreshByPoint(HIPoint point)
point - A point.public void refreshByPoints(java.util.ArrayList<HIPoint> points)
points - An array of points.public void setAnimation(java.lang.Boolean animation)
public void setBackgroundColor(HIColor backgroundColor)
public void setBorderColor(HIColor borderColor)
public void setBorderRadius(java.lang.Number borderRadius)
public void setBorderWidth(java.lang.Number borderWidth)
public void setClassName(java.lang.String className)
public void setClusterFormat(java.lang.String clusterFormat)
public void setDateTimeLabelFormats(HIDateTimeLabelFormats dateTimeLabelFormats)
public void setDistance(java.lang.Number distance)
public void setEnabled(java.lang.Boolean enabled)
public void setFollowPointer(java.lang.Boolean followPointer)
public void setFollowTouchMove(java.lang.Boolean followTouchMove)
public void setFooterFormat(java.lang.String footerFormat)
public void setFormat(java.lang.String format)
public void setFormatter(HIFunction formatter)
public void setHeaderFormat(java.lang.String headerFormat)
public void setHeaderShape(java.lang.String headerShape)
public void setHideDelay(java.lang.Number hideDelay)
public void setLinkFormat(java.lang.String linkFormat)
public void setNodeFormat(java.lang.String nodeFormat)
public void setNodeFormatter(HIFunction nodeFormatter)
public void setNullFormat(java.lang.String nullFormat)
public void setNullFormatter(HIFunction nullFormatter)
public void setOutside(java.lang.Boolean outside)
public void setPadding(java.lang.Number padding)
public void setPointFormat(java.lang.String pointFormat)
public void setPointFormatter(HIFunction pointFormatter)
public void setPositioner(HIFunction positioner)
public void setShadow(HIShadowOptionsObject shadow)
public void setShape(java.lang.String shape)
public void setShared(java.lang.Boolean shared)
public void setSnap(java.lang.Number snap)
public void setSplit(java.lang.Boolean split)
public void setStickOnContact(java.lang.Boolean stickOnContact)
public void setStyle(HICSSObject style)
public void setUseHTML(java.lang.Boolean useHTML)
public void setValueDecimals(java.lang.Number valueDecimals)
public void setValuePrefix(java.lang.String valuePrefix)
public void setValueSuffix(java.lang.String valueSuffix)
public void setXDateFormat(java.lang.String xDateFormat)
public void update(HITooltip options)
options - The tooltip options to update.