org.pepstock.charba.client.items

Class TooltipItem

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.items.TooltipItem

public final class TooltipItem
extends NativeObjectContainer

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

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TooltipItem.TooltipItemFactory Inner class to create tooltip item by a native object.

Constructor Summary

Constructors

Constructor and Description
TooltipItem(NativeObject nativeObject) Creates the item using a native java script object which contains all properties.

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.
String	getLabel() Returns the label for the tooltip.
String	getValue() Returns the value for the tooltip.
int	getX() Returns the X location of tooltip item.
int	getY() Returns the Y location of tooltip item.

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

Constructor Detail

TooltipItem

public TooltipItem(NativeObject nativeObject)

Creates the item using a native java script object which contains all properties.

Parameters:

nativeObject - native java script object which contains all properties.

Method Detail

getLabel

public String getLabel()

Returns the label for the tooltip.

Returns:

the label for the tooltip. Default is UndefinedValues.STRING.

getValue

public String getValue()

Returns the value for the tooltip.

Returns:

the value for the tooltip. 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.

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.

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.