Package org.pepstock.charba.client.annotation

Class AnnotationOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.annotation.AnnotationOptions

All Implemented Interfaces:

HasCallbackScope, IsDefaultEventHandler, HasEvents

public final class AnnotationOptions
extends AbstractPluginOptions
implements HasCallbackScope

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	Description
static DrawTime	DEFAULT_DRAW_TIME	Default draw time, DrawTime.AFTER_DATASETS_DRAW.

Constructor Summary

Constructors

Constructor	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	Description
void	addAnnotations(AbstractAnnotation... annotations)	Adds an annotations for plugin.
protected void	applyingDefaults()	This is invoked before storing the plugins options as default.
IsAnimations	getAnimations()	Returns the configuration to manage the annotation animations
AbstractAnnotation	getAnnotation(String id)	Returns the annotation with the id passed as argument or null if not exist.
AbstractAnnotation	getAnnotation(AnnotationId id)	Returns the annotation with the id passed as argument or null if not exist.
List<AbstractAnnotation>	getAnnotations()	Returns the collection of annotations.
default ClickCallback	getClickCallback()	Returns the callback called when a "click" event is occurring.
DrawTime	getDrawTime()	Returns the draw time which defines when the annotations are drawn.
default EnterCallback	getEnterCallback()	Returns the callback called when a "enter" event is occurring.
org.pepstock.charba.client.annotation.EventsHandler	getEventsHandler()
Interaction	getInteraction()	Returns the configuration which events trigger plugin interactions
default LeaveCallback	getLeaveCallback()	Returns the callback called when a "leave" event is occurring.
String	getScope()	Returns the scope of the options, which is the annotation plugin.
boolean	hasAnnotation(String id)	Returns true if the annotation with the id passed as argument exists.
boolean	hasAnnotation(AnnotationId id)	Returns true if the annotation with the id passed as argument exists.
boolean	isClip()	Returns if clips relative to the chart area.
void	removeAnnotation(String id)	Removes the annotation by the id passed as argument, if exists.
void	removeAnnotation(AnnotationId id)	Removes the annotation by the id passed as argument, if exists.
void	setAnnotations(AbstractAnnotation... annotations)	Sets a set of annotations for plugin.
default void	setClickCallback(ClickCallback clickCallback)	Sets the callback called when a "click" event is occurring.
void	setClip(boolean clip)	Sets how to clip relative to the chart area. If false allows overflow, otherwise true clips that many pixels inside the chart area.
void	setDrawTime(DrawTime drawTime)	Sets the draw time which defines when the annotations are drawn.
default void	setEnterCallback(EnterCallback enterCallback)	Sets the callback called when a "enter" event is occurring.
default void	setLeaveCallback(LeaveCallback leaveCallback)	Sets the callback called when a "leave" event is occurring.

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

applyingDefaults, getEventsOptionHandler, getId, getPluginId, loadGlobalsPluginOptions, store, store, store, store

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

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

checkAndGetColor, checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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

Methods inherited from interface org.pepstock.charba.client.options.HasEvents

getEvents, setEvents, setEvents

Field Detail

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

applyingDefaults

protected void applyingDefaults()

Description copied from class: AbstractPluginOptions

This is invoked before storing the plugins options as default.

Overrides:

applyingDefaults in class AbstractPluginOptions

getEventsHandler

public org.pepstock.charba.client.annotation.EventsHandler getEventsHandler()

getInteraction

public Interaction getInteraction()

Returns the configuration which events trigger plugin interactions

Returns:

the configuration which events trigger plugin interactions

getAnimations

public IsAnimations getAnimations()

Returns the configuration to manage the annotation animations

Returns:

the configuration to manage the annotation animations

getScope

public String getScope()

Returns the scope of the options, which is the annotation plugin.

Specified by:

getScope in interface HasCallbackScope

Returns:

the scope of the options

setClip

public void setClip(boolean clip)

Sets how to clip relative to the chart area.
If false allows overflow, otherwise true clips that many pixels inside the chart area.

Parameters:

clip - If false allows overflow, otherwise true clips that many pixels inside the chart area.

isClip

public boolean isClip()

Returns if clips relative to the chart area.

Returns:

true if clips relative to the chart area.

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

hasAnnotation

public boolean hasAnnotation(String id)

Returns true if the annotation with the id passed as argument exists.

Parameters:

id - annotation id to check

Returns:

true if the annotation with the id passed as argument exists

hasAnnotation

public boolean hasAnnotation(AnnotationId id)

Returns true if the annotation with the id passed as argument exists.

Parameters:

id - annotation id to check

Returns:

true if the annotation with the id passed as argument exists

removeAnnotation

public void removeAnnotation(String id)

Removes the annotation by the id passed as argument, if exists.

Parameters:

id - annotation id to check

removeAnnotation

public void removeAnnotation(AnnotationId id)

Removes the annotation by the id passed as argument, if exists.

Parameters:

id - annotation id to check

addAnnotations

public void addAnnotations(AbstractAnnotation... annotations)

Adds an annotations for plugin.

Parameters:

annotations - set of annotations.

setAnnotations

public void setAnnotations(AbstractAnnotation... annotations)

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

Parameters:

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

getAnnotations

public List<AbstractAnnotation> getAnnotations()

Returns the collection of annotations.

Returns:

the collection of annotations

getAnnotation

public AbstractAnnotation getAnnotation(String id)

Returns the annotation with the id passed as argument or null if not exist.

Parameters:

id - annotation id to use to retrieve the annotation

Returns:

the annotation or null if not exist

getAnnotation

public AbstractAnnotation getAnnotation(AnnotationId id)

Returns the annotation with the id passed as argument or null if not exist.

Parameters:

id - annotation id to check

Returns:

the annotation with the id passed as argument or null if not exist

getEnterCallback

public default EnterCallback getEnterCallback()

Returns the callback called when a "enter" event is occurring.

Returns:

the callback called when a "enter" event is occurring

setEnterCallback

public default void setEnterCallback(EnterCallback enterCallback)

Sets the callback called when a "enter" event is occurring.

Parameters:

enterCallback - the callback called when a "enter" event is occurring

getLeaveCallback

public default LeaveCallback getLeaveCallback()

Returns the callback called when a "leave" event is occurring.

Returns:

the callback called when a "leave" event is occurring

setLeaveCallback

public default void setLeaveCallback(LeaveCallback leaveCallback)

Sets the callback called when a "leave" event is occurring.

Parameters:

leaveCallback - the callback called when a "leave" event is occurring

getClickCallback

public default ClickCallback getClickCallback()

Returns the callback called when a "click" event is occurring.

Returns:

the callback called when a "click" event is occurring

setClickCallback

public default void setClickCallback(ClickCallback clickCallback)

Sets the callback called when a "click" event is occurring.

Parameters:

clickCallback - the callback called when a "click" event is occurring