org.pepstock.charba.client.options

Class Hover

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<Options,IsDefaultHover>

org.pepstock.charba.client.options.Hover

All Implemented Interfaces:

IsDefaultHover

public final class Hover
extends AbstractModel<Options,IsDefaultHover>
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
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.
InteractionMode	getMode() Returns which elements appear in the tooltip.
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.
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.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

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

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

Method Detail

setMode

public void setMode(InteractionMode mode)

Sets which elements appear in the tooltip.

Parameters:

mode - which elements appear in the tooltip.

getMode

public InteractionMode getMode()

Returns which elements appear in the tooltip.

Specified by:

getMode in interface IsDefaultHover

Returns:

which elements appear in the tooltip.

setIntersect

public 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 boolean isIntersect()

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

Specified by:

isIntersect in interface IsDefaultHover

Returns:

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

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.