org.pepstock.charba.client.impl.plugins

Class ColorSchemes

java.lang.Object

org.pepstock.charba.client.plugins.AbstractPlugin

org.pepstock.charba.client.impl.plugins.ColorSchemes

All Implemented Interfaces:

Plugin

public final class ColorSchemes
extends AbstractPlugin

Default plugin implementation to use color schemes instead the single colors for border and background colors of chart.
It enables to pick the color combination for charts from the predefined or custom color schemes.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static ColorSchemesOptionsFactory	FACTORY Data labels options factory
static String	ID Plugin ID "charbacolorschemes".

Method Summary

Modifier and Type	Method and Description
static ColorSchemes	get() Returns the singleton instance of plugin.
String	getId() Plugins must define a unique id in order to be configurable. Returns the plugin id.
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, onAfterDraw, onAfterEvent, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeDraw, 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 "charbacolorschemes".

See Also:

Constant Field Values

FACTORY

public static final ColorSchemesOptionsFactory FACTORY

Data labels options factory

Method Detail

get

public static ColorSchemes 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.

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.