org.pepstock.charba.client.callbacks

Interface TooltipFooterCallback

All Known Implementing Classes:

AbstractTooltipFooterCallback

public interface TooltipFooterCallback

The tooltip label configuration is nested below the tooltip configuration using the callbacks key.
The tooltip has the following callbacks for providing text.
All functions must return either a string or an array of strings. Arrays of strings are treated as multiple lines of text.
This interface takes care about labels to apply to the footer.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	onAfterFooter(IsChart chart, java.util.List<TooltipItem> items) Text to render after the footer section.
java.util.List<java.lang.String>	onBeforeFooter(IsChart chart, java.util.List<TooltipItem> items) Returns text to render before the footer section.
java.util.List<java.lang.String>	onFooter(IsChart chart, java.util.List<TooltipItem> items) Returns text to render as the footer of the tooltip.

Method Detail

onBeforeFooter

java.util.List<java.lang.String> onBeforeFooter(IsChart chart,
                                                java.util.List<TooltipItem> items)

Returns text to render before the footer section.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

a list of labels to apply to the title. If returns null or empty list, it will be ignored.

onFooter

java.util.List<java.lang.String> onFooter(IsChart chart,
                                          java.util.List<TooltipItem> items)

Returns text to render as the footer of the tooltip.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

a list of labels to apply to the title. If returns null or empty list, it will be ignored.

onAfterFooter

java.util.List<java.lang.String> onAfterFooter(IsChart chart,
                                               java.util.List<TooltipItem> items)

Text to render after the footer section.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

a list of labels to apply to the title. If returns null or empty list, it will be ignored.