Package org.pepstock.charba.client.defaults.chart

Class DefaultChartInteraction

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartInteraction

All Implemented Interfaces:

IsDefaultInteraction

Direct Known Subclasses:

DefaultChartHover

public class DefaultChartInteraction
extends Object
implements IsDefaultInteraction

Defaults for interaction option element, based on chart type.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor	Description
DefaultChartInteraction(IsDefaultInteraction interaction)	Creates the object by interaction option element instance.

Method Summary

Modifier and Type	Method	Description
InteractionAxis	getAxis()	Returns which directions are used in calculating distances.
IsInteractionMode	getMode()	Returns which elements appear in the tooltip.
boolean	isIncludeInvisible()	If true, the invisible points that are outside of the chart area will also be included when evaluating interactions.
boolean	isIntersect()	If true, the hover mode only applies when the mouse position intersects an item on the chart.

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.IsDefaultInteraction

create

Constructor Detail

DefaultChartInteraction

public DefaultChartInteraction(IsDefaultInteraction interaction)

Creates the object by interaction option element instance.

Parameters:

interaction - interaction option element instance.

Method Detail

getMode

public final IsInteractionMode getMode()

Description copied from interface: IsDefaultInteraction

Returns which elements appear in the tooltip.

Specified by:

getMode in interface IsDefaultInteraction

Returns:

which elements appear in the tooltip.

isIntersect

public final boolean isIntersect()

Description copied from interface: IsDefaultInteraction

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

Specified by:

isIntersect in interface IsDefaultInteraction

Returns:

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

getAxis

public final InteractionAxis getAxis()

Description copied from interface: IsDefaultInteraction

Returns which directions are used in calculating distances.

Specified by:

getAxis in interface IsDefaultInteraction

Returns:

define which directions are used in calculating distances.

isIncludeInvisible

public boolean isIncludeInvisible()

Description copied from interface: IsDefaultInteraction

If true, the invisible points that are outside of the chart area will also be included when evaluating interactions.

Specified by:

isIncludeInvisible in interface IsDefaultInteraction

Returns:

if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.