org.pepstock.charba.client.options

Class Hover

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Hover

All Implemented Interfaces:

IsDefaultHover

public final class Hover
extends NativeObjectContainer
implements IsDefaultHover

Definitions about how elements appear in the tooltip, hovering the chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
int	getAnimationDuration() Returns the duration in milliseconds it takes to animate hover style changes.
InteractionAxis	getAxis() Returns to 'x', 'y', or 'xy' to define which directions are used in calculating distances.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
InteractionMode	getMode() Returns which elements appear in the tooltip.
protected P	getParent() Returns the parent element.
boolean	isIntersect() if true, the hover mode only applies when the mouse position intersects an item on the chart.
void	setAnimationDuration(int milliseconds) Sets the duration in milliseconds it takes to animate hover style changes.
void	setAxis(InteractionAxis axis) Sets to 'x', 'y', or 'xy' to define which directions are used in calculating distances. Defaults to 'x' for index mode and 'xy' in dataset and nearest modes.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.
void	setIntersect(boolean intersect) if true, the hover mode only applies when the mouse position intersects an item on the chart.
void	setMode(InteractionMode mode) Sets which elements appear in the tooltip.

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

checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, 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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultHover

getMode, isIntersect

Method Detail

setAnimationDuration

public void setAnimationDuration(int milliseconds)

Sets the duration in milliseconds it takes to animate hover style changes.

Parameters:

milliseconds - duration in milliseconds it takes to animate hover style changes.

getAnimationDuration

public int getAnimationDuration()

Returns the duration in milliseconds it takes to animate hover style changes.

Specified by:

getAnimationDuration in interface IsDefaultHover

Returns:

duration in milliseconds it takes to animate hover style changes.

setAxis

public void setAxis(InteractionAxis axis)

Sets to 'x', 'y', or 'xy' to define which directions are used in calculating distances.
Defaults to 'x' for index mode and 'xy' in dataset and nearest modes.

Parameters:

axis - define which directions are used in calculating distances.

getAxis

public InteractionAxis getAxis()

Returns to 'x', 'y', or 'xy' to define which directions are used in calculating distances.

Specified by:

getAxis in interface IsDefaultHover

Returns:

define which directions are used in calculating distances.

setMode

public final void setMode(InteractionMode mode)

Sets which elements appear in the tooltip.

Parameters:

mode - which elements appear in the tooltip.

getMode

public final InteractionMode getMode()

Returns which elements appear in the tooltip.

Returns:

which elements appear in the tooltip.

setIntersect

public final void setIntersect(boolean intersect)

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

Parameters:

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

isIntersect

public final boolean isIntersect()

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

Returns:

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

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.