org.pepstock.charba.client.options

Class Hover

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.Hover

public final class Hover
extends ChartContainer

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.commons.ChartContainer

getChart

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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.

See Also:

InteractionMode

getMode

public InteractionMode getMode()

Returns which elements appear in the tooltip.

Returns:

which elements appear in the tooltip. For default see Options.getHover().

See Also:

InteractionMode

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.

Returns:

if true, the hover mode only applies when the mouse position intersects an item on the chart. For default see Options.getHover().

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.

Returns:

duration in milliseconds it takes to animate hover style changes. For default see Options.getHover().

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.

See Also:

InteractionAxis

getAxis

public InteractionAxis getAxis()

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

Returns:

define which directions are used in calculating distances. For default see Options.getHover().

See Also:

InteractionAxis