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.- Author:
- Andrea "Stock" Stocchero
-
-
Field Summary
Fields Modifier and Type Field Description static HtmlLegendOptionsFactory
FACTORY
The factory to create options for plugin.static String
ID
Plugin ID "charbahtmllegend".
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HtmlLegend
get()
Returns the singleton instance of plugin.void
onAfterDraw(IsChart chart)
Called after the 'chart' has been drawn.
Note that this hook will not be called if the drawing has been previously cancelled.void
onBeginDrawing(IsChart chart, boolean overridePreviousUpdate)
Called before every drawing cycle, coming from initialization, updating or rendering of chart.void
onConfigure(IsChart chart)
Called before initializing configuration of 'chart'.void
onDestroy(IsChart chart)
Called after the chart as been destroyed.void
onEndDrawing(IsChart chart)
Called after every drawing cycle, coming from initialization, updating or rendering of chart.-
Methods inherited from class org.pepstock.charba.client.plugins.AbstractPlugin
getId, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.pepstock.charba.client.Plugin
onAfterBuildTicks, onAfterDataLimits, onAfterDatasetDraw, onAfterDatasetsDraw, onAfterDatasetsUpdate, onAfterDatasetUpdate, onAfterEvent, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeBuildTicks, onBeforeDataLimits, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeDraw, onBeforeElementsUpdate, onBeforeEvent, onBeforeInit, onBeforeLayout, onBeforeRender, onBeforeTooltipDraw, onBeforeUpdate, onInstall, onReset, onResize, onStart, onStop, onUninstall
-
-
-
-
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
-
onConfigure
public void onConfigure(IsChart chart)
Description copied from interface:Plugin
Called before initializing configuration of 'chart'.- Parameters:
chart
- the chart instance.
-
onBeginDrawing
public void onBeginDrawing(IsChart chart, boolean overridePreviousUpdate)
Description copied from interface:Plugin
Called before every drawing cycle, coming from initialization, updating or rendering of chart.- Parameters:
chart
- the chart instanceoverridePreviousUpdate
- iftrue
the drawing was already running.
-
onAfterDraw
public void onAfterDraw(IsChart chart)
Description copied from interface:Plugin
Called after the 'chart' has been drawn.
Note that this hook will not be called if the drawing has been previously cancelled.- Parameters:
chart
- the chart instance.
-
onEndDrawing
public void onEndDrawing(IsChart chart)
Description copied from interface:Plugin
Called after every drawing cycle, coming from initialization, updating or rendering of chart.- Parameters:
chart
- the chart instance
-
-