org.pepstock.charba.client.impl.plugins

Class DatasetsItemsSelector

java.lang.Object

org.pepstock.charba.client.plugins.AbstractPlugin

org.pepstock.charba.client.impl.plugins.DatasetsItemsSelector

All Implemented Interfaces:

Plugin

public final class DatasetsItemsSelector
extends AbstractPlugin

Enables the datasets items selection directly into the canvas.
It works only for line and bar chart instances.
It will add mouser listeners to canvas.
Tooltips will be disable to avoid events conflicts.
Overrides also the events which can be caught (only click and touchstart).
It activates also the legend click handler to avoid that all datasets will be hidden.

Author:

Andrea "Stock" Stocchero

See Also:

AtLeastOneDatasetHandler

Field Summary

Fields

Modifier and Type	Field and Description
static DatasetsItemsSelectorOptionsFactory	FACTORY The factory to read options for plugin
static String	ID Plugin ID "charbadatasetsitemsselector".

Method Summary

Modifier and Type	Method and Description
void	clearSelection(IsChart chart) Clears the selection on the chart.
void	clearSelection(IsChart chart, boolean fireEvent) Clears the selection on the chart and set if an event should fire on clear action.
static DatasetsItemsSelector	get() Returns the singleton instance of plugin.
String	getId() Plugins must define a unique id in order to be configurable. Returns the plugin id.
double	getPadding(IsChart chart) Returns the padding height used by clear selection element if enabled. This is very helpful when you have added padding for your purposes and you need to know the amount of space that the element allocated.
void	onAfterDraw(IsChart chart, double easing) Called after the 'chart' has been drawn for the specific easing value.
boolean	onBeforeEvent(IsChart chart, ChartNativeEvent event) Called before processing the specified 'event'.
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.
void	skipNextRefreshFireEvent(IsChart chart) Sets a flag to skip to send event after refresh.

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

onAfterDatasetDraw, onAfterDatasetsDraw, onAfterDatasetsUpdate, onAfterDatasetUpdate, onAfterEvent, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeDraw, 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 "charbadatasetsitemsselector".

See Also:

Constant Field Values

FACTORY

public static final DatasetsItemsSelectorOptionsFactory FACTORY

The factory to read options for plugin

Method Detail

get

public static DatasetsItemsSelector get()

Returns the singleton instance of plugin.

Returns:

the singleton instance of plugin

getPadding

public double getPadding(IsChart chart)

Returns the padding height used by clear selection element if enabled.
This is very helpful when you have added padding for your purposes and you need to know the amount of space that the element allocated.

Parameters:

chart - chart instance

Returns:

the padding height used by clear selection element or ClearSelection.DEFAULT_VALUE if disabled

clearSelection

public void clearSelection(IsChart chart)

Clears the selection on the chart. With this method, it don't fire any clear event if not selected into plugin options.

Parameters:

chart - chart instance to clear the selection

See Also:

DatasetsItemsSelectorOptions.isFireEventOnClearSelection(), DatasetsItemsSelectorOptions.setFireEventOnClearSelection(boolean)

clearSelection

public void clearSelection(IsChart chart,
                           boolean fireEvent)

Clears the selection on the chart and set if an event should fire on clear action.

Parameters:

chart - chart instance to clear the selection

fireEvent - if true an event is fired otherwise not.

skipNextRefreshFireEvent

public void skipNextRefreshFireEvent(IsChart chart)

Sets a flag to skip to send event after refresh. This is helpful for drill down implementation.

Parameters:

chart - chart instance to apply the fire events skipping.

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.

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.

onBeforeEvent

public boolean onBeforeEvent(IsChart chart,
                             ChartNativeEvent event)

Description copied from interface: Plugin

Called before processing the specified 'event'. If any plugin returns false, the event will be discarded.

Specified by:

onBeforeEvent in interface Plugin

Overrides:

onBeforeEvent in class AbstractPlugin

Parameters:

chart - the chart instance.

event - The event object.

Returns:

false to discard the event.