org.pepstock.charba.client.callbacks

Interface TooltipTitleCallback

public interface TooltipTitleCallback

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 title.

Author:

Andrea "Stock" Stocchero

See Also:

TooltipsCallbacks

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	onAfterTitle(AbstractChart<?,?> chart, java.util.List<TooltipItem> items) Returns text to render after the title.
java.lang.String[]	onBeforeTitle(AbstractChart<?,?> chart, java.util.List<TooltipItem> items) Returns the text to render before the title.
java.lang.String[]	onTitle(AbstractChart<?,?> chart, java.util.List<TooltipItem> items) Returns text to render as the title of the tooltip.

Method Detail

onBeforeTitle

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

Returns the text to render before the title.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

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

See Also:

AbstractChart, TooltipItem

onTitle

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

Returns text to render as the title of the tooltip.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

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

See Also:

AbstractChart, TooltipItem

onAfterTitle

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

Returns text to render after the title.

Parameters:

chart - chart instance

items - list of all tooltip items

Returns:

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

See Also:

AbstractChart, TooltipItem