org.pepstock.charba.client.annotation

Class AnnotationOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.plugins.AbstractPluginCachedOptions

org.pepstock.charba.client.annotation.AnnotationOptions

public final class AnnotationOptions
extends AbstractPluginCachedOptions

This is the AnnotationPlugin.ID plugin options where to set all configuration items needed to the plugin.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DOUBLE_CLICK_SPEED Default double click speed in milliseconds, 350.
static DrawTime	DEFAULT_DRAW_TIME Default draw time, DrawTime.AFTER_DATASETS_DRAW.

Constructor Summary

Constructors

Constructor and Description
AnnotationOptions() Creates new AnnotationPlugin.ID plugin options.
AnnotationOptions(IsChart chart) Creates new AnnotationPlugin.ID plugin options, relating to chart instance for default.

Method Summary

Modifier and Type	Method and Description
List<AbstractAnnotation>	getAnnotations() Returns the list of annotations.
List<AbstractAnnotation>	getAnnotations(boolean binding) Returns the list of annotations.
int	getDoubleClickSpeed() Returns the double-click speed in milliseconds used to distinguish single-clicks from double-clicks whenever you need to capture both. When listening for both Event.CLICK and Event.DOUBLE_CLICK, click events will be delayed by this amount.
DrawTime	getDrawTime() Returns the draw time which defines when the annotations are drawn.
List<Event>	getEvents() Returns the browser events to enable on each annotation.
void	setAnnotations(AbstractAnnotation... annotations) Sets a set of annotations for plugin.
void	setDoubleClickSpeed(int speed) Sets the double-click speed in milliseconds used to distinguish single-clicks from double-clicks whenever you need to capture both. When listening for both Event.CLICK and Event.DOUBLE_CLICK, click events will be delayed by this amount.
void	setDrawTime(DrawTime drawTime) Sets the draw time which defines when the annotations are drawn.
void	setEvents(Event... events) Sets the browser events to enable on each annotation.

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

getInnerOptions, getReferences, register

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

getId, getPluginId, loadGlobalsPluginOptions, store, store, store, store

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOUBLE_CLICK_SPEED

public static final int DEFAULT_DOUBLE_CLICK_SPEED

Default double click speed in milliseconds, 350.

See Also:

Constant Field Values

DEFAULT_DRAW_TIME

public static final DrawTime DEFAULT_DRAW_TIME

Default draw time, DrawTime.AFTER_DATASETS_DRAW.

Constructor Detail

AnnotationOptions

public AnnotationOptions()

Creates new AnnotationPlugin.ID plugin options.

AnnotationOptions

public AnnotationOptions(IsChart chart)

Creates new AnnotationPlugin.ID plugin options, relating to chart instance for default.

Parameters:

chart - chart instance related to the plugin options

Method Detail

setDrawTime

public void setDrawTime(DrawTime drawTime)

Sets the draw time which defines when the annotations are drawn.

Parameters:

drawTime - the draw time which defines when the annotations are drawn

getDrawTime

public DrawTime getDrawTime()

Returns the draw time which defines when the annotations are drawn.

Returns:

the draw time which defines when the annotations are drawn

setDoubleClickSpeed

public void setDoubleClickSpeed(int speed)

Sets the double-click speed in milliseconds used to distinguish single-clicks from double-clicks whenever you need to capture both.
When listening for both Event.CLICK and Event.DOUBLE_CLICK, click events will be delayed by this amount.

Parameters:

speed - the double-click speed in milliseconds

getDoubleClickSpeed

public int getDoubleClickSpeed()

Returns the double-click speed in milliseconds used to distinguish single-clicks from double-clicks whenever you need to capture both.
When listening for both Event.CLICK and Event.DOUBLE_CLICK, click events will be delayed by this amount.

Returns:

the double-click speed in milliseconds

setEvents

public void setEvents(Event... events)

Sets the browser events to enable on each annotation.

Parameters:

events - the browser events to enable on each annotation.

getEvents

public List<Event> getEvents()

Returns the browser events to enable on each annotation.

Returns:

the browser events to enable on each annotation

setAnnotations

public void setAnnotations(AbstractAnnotation... annotations)

Sets a set of annotations for plugin. If argument is null, removes all annotations.

Parameters:

annotations - set of anotation. If null, removes all annotations

getAnnotations

public List<AbstractAnnotation> getAnnotations()

Returns the list of annotations.

Returns:

the list of annotations

getAnnotations

public List<AbstractAnnotation> getAnnotations(boolean binding)

Returns the list of annotations.

Parameters:

binding - if true binds the new array list into container

Returns:

the list of annotations