org.pepstock.charba.client.items

Class TooltipItem

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.items.TooltipItem

public final class TooltipItem
extends JavaScriptObjectContainer

Contains all info for every item of tooltip.
Created and passed by CHART.JS.
It uses into the tooltips callbacks.

Author:

Andrea "Stock" Stocchero

See Also:

TooltipLabelCallback, TooltipBodyCallback, TooltipItemSortHandler, TooltipFilterHandler, TooltipFooterCallback, TooltipTitleCallback

Constructor Summary

Constructors

Constructor and Description
TooltipItem(GenericJavaScriptObject javaScriptObject) Wraps the CHART.JS java script object.

Method Summary

Modifier and Type	Method and Description
int	getDatasetIndex() Returns the dataset index of the chart
int	getIndex() Returns the index of the data inside the dataset.
int	getX() Returns the X location of tooltip item.
java.lang.String	getXLabel() Returns the X location of label.
int	getY() Returns the Y location of tooltip item.
java.lang.String	getYLabel() Returns the Y location of label.

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

Constructor Detail

TooltipItem

public TooltipItem(GenericJavaScriptObject javaScriptObject)

Wraps the CHART.JS java script object.

Parameters:

javaScriptObject - CHART.JS java script object

Method Detail

getXLabel

public java.lang.String getXLabel()

Returns the X location of label.

Returns:

the X location of label. Default is UndefinedValues.STRING.

getYLabel

public java.lang.String getYLabel()

Returns the Y location of label.

Returns:

the Y location of label. Default is UndefinedValues.STRING.

getDatasetIndex

public int getDatasetIndex()

Returns the dataset index of the chart

Returns:

the dataset index of the chart. Default is UndefinedValues.INTEGER.

See Also:

Data.getDatasets()

getIndex

public int getIndex()

Returns the index of the data inside the dataset.

Returns:

the index of the data inside the dataset. Default is UndefinedValues.INTEGER.

See Also:

Dataset.getData(), Data.getLabels()

getX

public int getX()

Returns the X location of tooltip item.

Returns:

the X location of tooltip item. Default is UndefinedValues.INTEGER.

getY

public int getY()

Returns the Y location of tooltip item.

Returns:

the Y location of tooltip item. Default is UndefinedValues.INTEGER.