org.pepstock.charba.client.callbacks

Interface TooltipFooterCallback

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

See Also:

TooltipsCallbacks

Method Summary

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

Method Detail

onBeforeFooter

java.lang.String[] onBeforeFooter(AbstractChart<?,?> 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:

an array of labels to apply to the footer. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem

onFooter

java.lang.String[] onFooter(AbstractChart<?,?> 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:

an array of labels to apply to the footer. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem

onAfterFooter

java.lang.String[] onAfterFooter(AbstractChart<?,?> chart,
                                 java.util.List<TooltipItem> items)

Text to render after the footer section.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

an array of labels to apply to the footer. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem