org.pepstock.charba.client.callbacks

Interface TooltipLabelCallback

public interface TooltipLabelCallback

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.

Author:

Andrea "Stock" Stocchero

See Also:

TooltipsCallbacks

Method Summary

Modifier and Type	Method and Description
java.lang.String	onAfterLabel(AbstractChart<?,?> chart, TooltipItem item) Returns text to render after an individual label.
java.lang.String	onBeforeLabel(AbstractChart<?,?> chart, TooltipItem item) Returns text to render before an individual label.
java.lang.String	onLabel(AbstractChart<?,?> chart, TooltipItem item) Returns text to render for an individual item in the tooltip.
TooltipLabelColor	onLabelColor(AbstractChart<?,?> chart, TooltipItem item) Returns the colors to render for the tooltip item.
IsColor	onLabelTextColor(AbstractChart<?,?> chart, TooltipItem item) Returns the colors for the text of the label for the tooltip item.

Method Detail

onBeforeLabel

java.lang.String onBeforeLabel(AbstractChart<?,?> chart,
                               TooltipItem item)

Returns text to render before an individual label. This will be called for each item in the tooltip.

Parameters:

chart - chart instance

item - tooltip item

Returns:

label to be applied. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem

onLabel

java.lang.String onLabel(AbstractChart<?,?> chart,
                         TooltipItem item)

Returns text to render for an individual item in the tooltip.

Parameters:

chart - chart instance

item - tooltip item

Returns:

label to be applied. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem

onLabelColor

TooltipLabelColor onLabelColor(AbstractChart<?,?> chart,
                               TooltipItem item)

Returns the colors to render for the tooltip item.

Parameters:

chart - chart instance

item - tooltip item

Returns:

label color to be applied. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem, TooltipLabelColor

onLabelTextColor

IsColor onLabelTextColor(AbstractChart<?,?> chart,
                         TooltipItem item)

Returns the colors for the text of the label for the tooltip item.

Parameters:

chart - chart instance

item - tooltip item

Returns:

label text color to be applied. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem

onAfterLabel

java.lang.String onAfterLabel(AbstractChart<?,?> chart,
                              TooltipItem item)

Returns text to render after an individual label.

Parameters:

chart - chart instance

item - tooltip item

Returns:

label to be applied. If returns null, it will be ignored.

See Also:

AbstractChart, TooltipItem