TooltipModel (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.JavaScriptObjectContainer
- - org.pepstock.charba.client.items.TooltipModel

```
public final class TooltipModel
extends JavaScriptObjectContainer
```
This object is passed by CHART.JS to the callback to manage tooltip custom callback.
The tooltip label configuration is nested below the tooltip configuration using the callbacks key. The tooltip has the following callbacks for providing text.
All methods must return either a string or an array of strings. Arrays of strings are treated as multiple lines of text.

Author:

Andrea "Stock" Stocchero

See Also:

TooltipCustomCallback

Constructor Summary

Constructors
Constructor and Description

TooltipModel(GenericJavaScriptObject javaScriptObject)
Wraps the CHART.JS java script object.

Constructors
Constructor and Description
`TooltipModel(GenericJavaScriptObject javaScriptObject)` Wraps the CHART.JS java script object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.String>`	`getAfterBody()` Returns the list of lines after body section.
`IsColor`	`getBackgroundColor()` Returns the background color of tooltip.
`java.lang.String`	`getBackgroundColorAsString()` Returns the background color of tooltip.
`java.util.List<java.lang.String>`	`getBeforeBody()` Returns the list of lines before body section.
`java.util.List<TooltipBodyItem>`	`getBody()` Returns the list of items which belong to the tooltip body section.
`TextAlign`	`getBodyAlign()` Returns the alignment of the tooltip body section.
`IsColor`	`getBodyFontColor()` Returns the color of the tooltip body section.
`java.lang.String`	`getBodyFontColorAsString()` Returns the color of the tooltip body section.
`java.lang.String`	`getBodyFontFamily()` Returns the font family of the tooltip body section.
`int`	`getBodyFontSize()` Returns the font size of the tooltip body section.
`FontStyle`	`getBodyFontStyle()` Returns the font style of the tooltip body section.
`int`	`getBodySpacing()` Returns the spacing of the tooltip body section.
`int`	`getCaretSize()` Returns the size, in px, of the tooltip arrow of footer section.
`int`	`getCaretX()` Returns the X location of the tooltip arrow.
`int`	`getCaretY()` Returns the Y location of the tooltip arrow.
`double`	`getCornerRadius()` Returns the radius of tooltip corner curves of footer section.
`java.util.List<TooltipItem>`	`getDataPoints()` Returns the list of tooltip items related to data points.
`java.lang.Boolean`	`getDisplayColors()` Returns the display of colors of tooltip.
`java.util.List<java.lang.String>`	`getFooter()` Returns the footer of the tooltip.
`TextAlign`	`getFooterAlign()` Returns the alignment of the tooltip footer section.
`IsColor`	`getFooterFontColor()` Returns the color of the tooltip footer section.
`java.lang.String`	`getFooterFontColorAsString()` Returns the color of the tooltip footer section.
`java.lang.String`	`getFooterFontFamily()` Returns the font family of the tooltip footer section.
`int`	`getFooterFontSize()` Returns the font size of the tooltip footer section.
`FontStyle`	`getFooterFontStyle()` Returns the font style of the tooltip footer section.
`int`	`getFooterMarginTop()` Returns the margin top of the tooltip footer section.
`int`	`getFooterSpacing()` Returns the spacing of the tooltip footer section.
`int`	`getHeight()` Returns the height of tooltip.
`java.util.List<TooltipLabelColor>`	`getLabelColors()` Returns the list of labels color of tooltip.
`IsColor`	`getLegendColorBackground()` Returns the legend color of tooltips.
`java.lang.String`	`getLegendColorBackgroundAsString()` Returns the legend color of tooltips.
`double`	`getOpacity()` Returns the opacity of tooltip.
`java.util.List<java.lang.String>`	`getTitle()` Returns the title of the tooltip.
`TextAlign`	`getTitleAlign()` Returns the alignment of the tooltip title section.
`IsColor`	`getTitleFontColor()` Returns the color of the tooltip title section.
`java.lang.String`	`getTitleFontColorAsString()` Returns the color of the tooltip title section.
`java.lang.String`	`getTitleFontFamily()` Returns the font family of the tooltip title section.
`int`	`getTitleFontSize()` Returns the font size of the tooltip title section.
`FontStyle`	`getTitleFontStyle()` Returns the font style of the tooltip title section.
`int`	`getTitleMarginBottom()` Returns the bottom margin of the tooltip title section.
`int`	`getTitleSpacing()` Returns the spacing of the tooltip title section.
`int`	`getWidth()` Returns the width of tooltip.
`int`	`getX()` Returns the X location of tooltip.
`java.lang.String`	`getXAlign()` Returns the X align location.
`int`	`getXPadding()` Returns the X padding location.
`int`	`getY()` Returns the Y location of tooltip.
`java.lang.String`	`getYAlign()` Returns the Y align location.
`int`	`getYPadding()` Returns the Y padding location.

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
  - TooltipModel
```
public TooltipModel(GenericJavaScriptObject javaScriptObject)
```
    Wraps the CHART.JS java script object.
    
    Parameters:
    
    javaScriptObject - CHART.JS java script object
- Method Detail
  - getDataPoints
```
public java.util.List<TooltipItem> getDataPoints()
```
    Returns the list of tooltip items related to data points.
    
    Returns:
    
    the list of tooltip items related to data points.
    
    See Also:
    
    TooltipItem
  - getXPadding
```
public int getXPadding()
```
    Returns the X padding location.
    
    Returns:
    
    the X padding location.
  - getYPadding
```
public int getYPadding()
```
    Returns the Y padding location.
    
    Returns:
    
    the Y padding location.
  - getXAlign
```
public java.lang.String getXAlign()
```
    Returns the X align location.
    
    Returns:
    
    the X align location. Default is UndefinedValues.STRING.
  - getYAlign
```
public java.lang.String getYAlign()
```
    Returns the Y align location.
    
    Returns:
    
    the Y align location. Default is UndefinedValues.STRING.
  - getX
```
public int getX()
```
    Returns the X location of tooltip.
    
    Returns:
    
    the X location of tooltip. Default is UndefinedValues.INTEGER.
  - getY
```
public int getY()
```
    Returns the Y location of tooltip.
    
    Returns:
    
    the Y location of tooltip. Default is UndefinedValues.INTEGER.
  - getWidth
```
public int getWidth()
```
    Returns the width of tooltip.
    
    Returns:
    
    the width of tooltip. Default is UndefinedValues.INTEGER.
  - getHeight
```
public int getHeight()
```
    Returns the height of tooltip.
    
    Returns:
    
    the height of tooltip. Default is UndefinedValues.INTEGER.
  - getCaretX
```
public int getCaretX()
```
    Returns the X location of the tooltip arrow.
    
    Returns:
    
    the X location of the tooltip arrow. Default is UndefinedValues.INTEGER.
  - getCaretY
```
public int getCaretY()
```
    Returns the Y location of the tooltip arrow.
    
    Returns:
    
    the Y location of the tooltip arrow. Default is UndefinedValues.INTEGER.
  - getBody
```
public java.util.List<TooltipBodyItem> getBody()
```
    Returns the list of items which belong to the tooltip body section.
    
    Returns:
    
    the list of items which belong to the tooltip body section.
    
    See Also:
    
    TooltipBodyItem
  - getBeforeBody
```
public java.util.List<java.lang.String> getBeforeBody()
```
    Returns the list of lines before body section.
    
    Returns:
    
    the list of lines before body section.
  - getAfterBody
```
public java.util.List<java.lang.String> getAfterBody()
```
    Returns the list of lines after body section.
    
    Returns:
    
    the list of lines after body section.
  - getBodyFontColorAsString
```
public java.lang.String getBodyFontColorAsString()
```
    Returns the color of the tooltip body section.
    
    Returns:
    
    the color of the tooltip body section.
  - getBodyFontColor
```
public IsColor getBodyFontColor()
```
    Returns the color of the tooltip body section.
    
    Returns:
    
    the color of the tooltip body section.
  - getBodyFontFamily
```
public java.lang.String getBodyFontFamily()
```
    Returns the font family of the tooltip body section.
    
    Returns:
    
    the font family of the tooltip body section.
  - getBodyFontStyle
```
public FontStyle getBodyFontStyle()
```
    Returns the font style of the tooltip body section.
    
    Returns:
    
    the font style of the tooltip body section.
    
    See Also:
    
    FontStyle
  - getBodyAlign
```
public TextAlign getBodyAlign()
```
    Returns the alignment of the tooltip body section.
    
    Returns:
    
    the alignment of the tooltip body section.
  - getBodyFontSize
```
public int getBodyFontSize()
```
    Returns the font size of the tooltip body section.
    
    Returns:
    
    the font size of the tooltip body section.
  - getBodySpacing
```
public int getBodySpacing()
```
    Returns the spacing of the tooltip body section.
    
    Returns:
    
    the spacing of the tooltip body section.
  - getTitle
```
public java.util.List<java.lang.String> getTitle()
```
    Returns the title of the tooltip.
    
    Returns:
    
    the title of the tooltip.
  - getTitleFontColorAsString
```
public java.lang.String getTitleFontColorAsString()
```
    Returns the color of the tooltip title section.
    
    Returns:
    
    the color of the tooltip title section.
  - getTitleFontColor
```
public IsColor getTitleFontColor()
```
    Returns the color of the tooltip title section.
    
    Returns:
    
    the color of the tooltip title section.
  - getTitleFontFamily
```
public java.lang.String getTitleFontFamily()
```
    Returns the font family of the tooltip title section.
    
    Returns:
    
    the font family of the tooltip title section.
  - getTitleFontStyle
```
public FontStyle getTitleFontStyle()
```
    Returns the font style of the tooltip title section.
    
    Returns:
    
    the font style of the tooltip title section.
    
    See Also:
    
    FontStyle
  - getTitleFontSize
```
public int getTitleFontSize()
```
    Returns the font size of the tooltip title section.
    
    Returns:
    
    the font size of the tooltip title section.
  - getTitleAlign
```
public TextAlign getTitleAlign()
```
    Returns the alignment of the tooltip title section.
    
    Returns:
    
    the alignment of the tooltip title section.
  - getTitleSpacing
```
public int getTitleSpacing()
```
    Returns the spacing of the tooltip title section.
    
    Returns:
    
    the spacing of the tooltip title section.
  - getTitleMarginBottom
```
public int getTitleMarginBottom()
```
    Returns the bottom margin of the tooltip title section.
    
    Returns:
    
    the bottom margin of the tooltip title section.
  - getFooter
```
public java.util.List<java.lang.String> getFooter()
```
    Returns the footer of the tooltip.
    
    Returns:
    
    the footer of the tooltip.
  - getFooterFontColorAsString
```
public java.lang.String getFooterFontColorAsString()
```
    Returns the color of the tooltip footer section.
    
    Returns:
    
    the color of the tooltip footer section.
  - getFooterFontColor
```
public IsColor getFooterFontColor()
```
    Returns the color of the tooltip footer section.
    
    Returns:
    
    the color of the tooltip footer section.
  - getFooterFontFamily
```
public java.lang.String getFooterFontFamily()
```
    Returns the font family of the tooltip footer section.
    
    Returns:
    
    the font family of the tooltip footer section.
  - getFooterFontStyle
```
public FontStyle getFooterFontStyle()
```
    Returns the font style of the tooltip footer section.
    
    Returns:
    
    the font style of the tooltip footer section.
    
    See Also:
    
    FontStyle
  - getFooterFontSize
```
public int getFooterFontSize()
```
    Returns the font size of the tooltip footer section.
    
    Returns:
    
    the font size of the tooltip footer section.
  - getFooterAlign
```
public TextAlign getFooterAlign()
```
    Returns the alignment of the tooltip footer section.
    
    Returns:
    
    the alignment of the tooltip footer section.
  - getFooterSpacing
```
public int getFooterSpacing()
```
    Returns the spacing of the tooltip footer section.
    
    Returns:
    
    the spacing of the tooltip footer section.
  - getFooterMarginTop
```
public int getFooterMarginTop()
```
    Returns the margin top of the tooltip footer section.
    
    Returns:
    
    the margin top of the tooltip footer section.
  - getCaretSize
```
public int getCaretSize()
```
    Returns the size, in px, of the tooltip arrow of footer section.
    
    Returns:
    
    the size, in px, of the tooltip arrow of footer section.
  - getCornerRadius
```
public double getCornerRadius()
```
    Returns the radius of tooltip corner curves of footer section.
    
    Returns:
    
    the radius of tooltip corner curves of footer section.
  - getBackgroundColorAsString
```
public java.lang.String getBackgroundColorAsString()
```
    Returns the background color of tooltip.
    
    Returns:
    
    the background color of tooltip.
  - getBackgroundColor
```
public IsColor getBackgroundColor()
```
    Returns the background color of tooltip.
    
    Returns:
    
    the background color of tooltip.
  - getLabelColors
```
public java.util.List<TooltipLabelColor> getLabelColors()
```
    Returns the list of labels color of tooltip.
    
    Returns:
    
    the list of labels color of tooltip.
    
    See Also:
    
    TooltipLabelColor
  - getOpacity
```
public double getOpacity()
```
    Returns the opacity of tooltip.
    
    Returns:
    
    the opacity of tooltip. Default is UndefinedValues.DOUBLE.
  - getLegendColorBackgroundAsString
```
public java.lang.String getLegendColorBackgroundAsString()
```
    Returns the legend color of tooltips.
    
    Returns:
    
    the legend color of tooltips.
  - getLegendColorBackground
```
public IsColor getLegendColorBackground()
```
    Returns the legend color of tooltips.
    
    Returns:
    
    the legend color of tooltips.
  - getDisplayColors
```
public java.lang.Boolean getDisplayColors()
```
    Returns the display of colors of tooltip.
    
    Returns:
    
    the display of colors of tooltip. Default is UndefinedValues.BOOLEAN.

Class TooltipModel

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

TooltipModel

Method Detail

getDataPoints

getXPadding

getYPadding

getXAlign

getYAlign

getX

getY

getWidth

getHeight

getCaretX

getCaretY

getBody

getBeforeBody

getAfterBody

getBodyFontColorAsString

getBodyFontColor

getBodyFontFamily

getBodyFontStyle

getBodyAlign

getBodyFontSize

getBodySpacing

getTitle

getTitleFontColorAsString

getTitleFontColor

getTitleFontFamily

getTitleFontStyle

getTitleFontSize

getTitleAlign

getTitleSpacing

getTitleMarginBottom

getFooter

getFooterFontColorAsString

getFooterFontColor

getFooterFontFamily

getFooterFontStyle

getFooterFontSize

getFooterAlign

getFooterSpacing

getFooterMarginTop

getCaretSize

getCornerRadius

getBackgroundColorAsString

getBackgroundColor

getLabelColors

getOpacity

getLegendColorBackgroundAsString

getLegendColorBackground

getDisplayColors