Package org.pepstock.charba.client.annotation

Class Interaction

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.annotation.Interaction

All Implemented Interfaces:

IsDefaultsAnnotationInteraction

public final class Interaction
extends NativeObjectContainer
implements IsDefaultsAnnotationInteraction

Definitions about how the user can interact with chart elements.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
InteractionAxis	getAxis()	Returns which directions are used in calculating distances.
InteractionMode	getMode()	Returns which the mode to engaged annotations on events.
boolean	isIntersect()	if true, the mode only applies when the mouse position intersects an item on the chart.
void	setAxis(InteractionAxis axis)	Sets which directions are used in calculating distances.
void	setIntersect(boolean intersect)	if true, the only applies when the mouse position intersects an annotation.
void	setMode(InteractionMode mode)	Sets which the mode to engaged annotations on events.

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

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, 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, 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

Method Detail

setMode

public void setMode(InteractionMode mode)

Sets which the mode to engaged annotations on events.

Parameters:

mode - which the mode to engaged annotations on events.

getMode

public InteractionMode getMode()

Returns which the mode to engaged annotations on events.

Specified by:

getMode in interface IsDefaultsAnnotationInteraction

Returns:

which the mode to engaged annotations on events.

setAxis

public void setAxis(InteractionAxis axis)

Sets which directions are used in calculating distances.

Parameters:

axis - define which directions are used in calculating distances.

getAxis

public InteractionAxis getAxis()

Returns which directions are used in calculating distances.

Specified by:

getAxis in interface IsDefaultsAnnotationInteraction

Returns:

define which directions are used in calculating distances.

setIntersect

public void setIntersect(boolean intersect)

if true, the only applies when the mouse position intersects an annotation.

Parameters:

intersect - if true, the mode only applies when the mouse position intersects an annotation.

isIntersect

public boolean isIntersect()

if true, the mode only applies when the mouse position intersects an item on the chart.

Specified by:

isIntersect in interface IsDefaultsAnnotationInteraction

Returns:

if true, the mode only applies when the mouse position intersects an item on the chart.