org.pepstock.charba.client.impl.plugins

Class HtmlLegend

java.lang.Object

org.pepstock.charba.client.plugins.AbstractPlugin

org.pepstock.charba.client.impl.plugins.HtmlLegend

All Implemented Interfaces:

Plugin

public final class HtmlLegend
extends AbstractPlugin

This plugin implements a HTML legend in order to give more flexibility to who needs to customize the legend.
It uses the HtmlLegendLabelsCallback to generated HTML legend.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static HtmlLegendOptionsFactory	FACTORY The factory to create options for plugin.
static String	ID Plugin ID "charbahtmllegend".

Method Summary

Modifier and Type	Method and Description
static HtmlLegend	get() Returns the singleton instance of plugin.
String	getId() Plugins must define a unique id in order to be configurable. Returns the plugin id.
void	onAfterDraw(IsChart chart, double easing) Called after the 'chart' has been drawn for the specific easing value.
boolean	onBeforeDraw(IsChart chart, double easing) Called before drawing 'chart' at every animation frame specified by the given easing value.
boolean	onBeforeUpdate(IsChart chart) Called before updating 'chart'.
void	onConfigure(IsChart chart) Called before initializing configuration of 'chart'.
void	onDestroy(IsChart chart) Called after the chart as been destroyed.

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPlugin

onAfterDatasetDraw, onAfterDatasetsDraw, onAfterDatasetsUpdate, onAfterDatasetUpdate, onAfterEvent, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeEvent, onBeforeInit, onBeforeLayout, onBeforeRender, onBeforeTooltipDraw, onResize, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final String ID

Plugin ID "charbahtmllegend".

See Also:

Constant Field Values

FACTORY

public static final HtmlLegendOptionsFactory FACTORY

The factory to create options for plugin.

Method Detail

get

public static HtmlLegend get()

Returns the singleton instance of plugin.

Returns:

the singleton instance of plugin

getId

public String getId()

Description copied from interface: Plugin

Plugins must define a unique id in order to be configurable.
Returns the plugin id. A plugin id

• can not start with a dot or an underscore
• can not contain any non-URL-safe characters
• cannot contain upper-case letters
• should be something short, but also reasonably descriptive

Returns:

the plugin id.

onConfigure

public void onConfigure(IsChart chart)

Description copied from interface: Plugin

Called before initializing configuration of 'chart'.

Specified by:

onConfigure in interface Plugin

Overrides:

onConfigure in class AbstractPlugin

Parameters:

chart - the chart instance.

onBeforeUpdate

public boolean onBeforeUpdate(IsChart chart)

Description copied from interface: Plugin

Called before updating 'chart'. If any plugin returns false, the update is cancelled (and thus subsequent render(s)) until another 'update' is triggered.

Specified by:

onBeforeUpdate in interface Plugin

Overrides:

onBeforeUpdate in class AbstractPlugin

Parameters:

chart - the chart instance.

Returns:

false to cancel the chart update.

onBeforeDraw

public boolean onBeforeDraw(IsChart chart,
                            double easing)

Description copied from interface: Plugin

Called before drawing 'chart' at every animation frame specified by the given easing value. If any plugin returns false, the frame drawing is cancelled until another 'render' is triggered.

Specified by:

onBeforeDraw in interface Plugin

Overrides:

onBeforeDraw in class AbstractPlugin

Parameters:

chart - the chart instance.

easing - The current animation value, between 0.0 and 1.0.

Returns:

false to cancel the chart drawing.

onAfterDraw

public void onAfterDraw(IsChart chart,
                        double easing)

Description copied from interface: Plugin

Called after the 'chart' has been drawn for the specific easing value. Note that this hook will not be called if the drawing has been previously cancelled.

Specified by:

onAfterDraw in interface Plugin

Overrides:

onAfterDraw in class AbstractPlugin

Parameters:

chart - the chart instance.

easing - The current animation value, between 0.0 and 1.0.

onDestroy

public void onDestroy(IsChart chart)

Description copied from interface: Plugin

Called after the chart as been destroyed.

Specified by:

onDestroy in interface Plugin

Overrides:

onDestroy in class AbstractPlugin

Parameters:

chart - the chart instance.