java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.commons.AbstractNode
  - - org.pepstock.charba.client.options.AbstractModel<P,D>
    - - org.pepstock.charba.client.options.Tooltips

All Implemented Interfaces:

IsDefaultAnimationContainer, IsDefaultAnimationTransition, IsDefaultBoxHandler, IsDefaultEventHandler, IsDefaultTextDirectionHandler, IsDefaultTooltips, HasAnimationOptions, HasEvents
```
public final class Tooltips
extends AbstractModel<P,D>
implements IsDefaultTooltips, HasAnimationOptions, HasEvents
```
Configuration element to set all attributes and features of the default tooltip.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method	Description
`AnimationContainer`	`getAnimationContainer()`	Returns an animation container instance to use in the default methods of this interface.
`IsColor`	`getBackgroundColor()`	Returns the background color of the tooltip.
`String`	`getBackgroundColorAsString()`	Returns the background color of the tooltip.
`TextAlign`	`getBodyAlign()`	Returns the body alignment.
`IsColor`	`getBodyColor()`	Returns the body font color.
`String`	`getBodyColorAsString()`	Returns the body font color as string.
`Font`	`getBodyFont()`	Returns the body font element.
`int`	`getBodySpacing()`	Returns the spacing to add to top and bottom of each tooltip item.
`IsColor`	`getBorderColor()`	Returns the color of the border.
`String`	`getBorderColorAsString()`	Returns the color of the border.
`int`	`getBorderWidth()`	Returns the size of the border.
`org.pepstock.charba.client.options.BoxHandler`	`getBoxHandler()`
`default int`	`getBoxHeight()`	Returns the height of colored box.
`int`	`getBoxPadding()`	Returns the padding between the color box and the text.
`default int`	`getBoxWidth()`	Returns the width of colored box.
`TooltipsCallbacks`	`getCallbacks()`	Returns the callbacks element.
`int`	`getCaretPadding()`	Returns the extra distance to move the end of the tooltip arrow away from the tooltip point.
`int`	`getCaretSize()`	Returns the size, in pixels, of the tooltip arrow.
`int`	`getCornerRadius()`	Returns the radius of tooltip corner curves.
`BarBorderRadius`	`getCornerRadiusAsObject()`	Returns the radius of tooltip corner curves.
`EventsOptionHandler`	`getEventsOptionHandler()`	Returns a event handler handler instance to use in the default methods of this interface.
`TextAlign`	`getFooterAlign()`	Returns the body alignment.
`IsColor`	`getFooterColor()`	Returns the footer font color.
`String`	`getFooterColorAsString()`	Returns the footer font color as string.
`Font`	`getFooterFont()`	Returns the footer font element.
`int`	`getFooterMarginTop()`	Returns the margin to add before drawing the footer.
`int`	`getFooterSpacing()`	Returns the spacing to add to top and bottom of each footer line.
`IsInteractionMode`	`getMode()`	Returns which elements appear in the interaction.
`IsColor`	`getMultiKeyBackground()`	Returns the color to draw behind the colored boxes when multiple items are in the tooltip.
`String`	`getMultiKeyBackgroundAsString()`	Returns the color to draw behind the colored boxes when multiple items are in the tooltip.
`Padding`	`getPadding()`	Returns the padding element.
`IsTooltipPosition`	`getPosition()`	Returns the mode for positioning the tooltip.
`default TextDirection`	`getTextDirection()`	Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
`org.pepstock.charba.client.options.TextDirectionHandler`	`getTextDirectionHandler()`
`TextAlign`	`getTitleAlign()`	Returns the title alignment.
`IsColor`	`getTitleColor()`	Returns the title font color.
`String`	`getTitleColorAsString()`	Returns the title font color as string.
`Font`	`getTitleFont()`	Returns the title font element.
`int`	`getTitleMarginBottom()`	Returns the margin to add on bottom of title section.
`int`	`getTitleSpacing()`	Returns the spacing to add to top and bottom of each title line.
`TooltipAlign`	`getXAlign()`	Returns the alignment of the tooltip caret in the X direction.
`TooltipAlign`	`getYAlign()`	Returns the alignment of the tooltip caret in the Y direction.
`boolean`	`isDisplayColors()`	If `true`, color boxes are shown in the tooltip.
`boolean`	`isEnabled()`	Returns `true` if tooltips are enabled.
`boolean`	`isIntersect()`	if `true`, the mode only applies when the mouse position intersects an item on the chart.
`default boolean`	`isRtl()`	Returns `true` for rendering the object from right to left.
`boolean`	`isUsePointStyle()`	Returns if to use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight).
`void`	`setBackgroundColor(String backgroundColor)`	Sets the background color of the tooltip.
`void`	`setBackgroundColor(IsColor backgroundColor)`	Sets the background color of the tooltip.
`void`	`setBodyAlign(TextAlign align)`	Sets the body alignment.
`void`	`setBodyColor(String color)`	Sets the body font color.
`void`	`setBodyColor(IsColor color)`	Sets the body font color.
`void`	`setBodySpacing(int bodySpacing)`	Sets the spacing to add to top and bottom of each tooltip item.
`void`	`setBorderColor(String borderColor)`	Sets the color of the border.
`void`	`setBorderColor(IsColor borderColor)`	Sets the color of the border.
`void`	`setBorderWidth(int borderWidth)`	Sets the size of the border.
`default void`	`setBoxHeight(int boxHeight)`	Sets the height of colored box.
`void`	`setBoxPadding(int boxPadding)`	Sets the padding between the color box and the text.
`default void`	`setBoxWidth(int boxWidth)`	Sets the width of colored box.
`void`	`setCaretPadding(int caretPadding)`	Sets the extra distance to move the end of the tooltip arrow away from the tooltip point.
`void`	`setCaretSize(int caretSize)`	Sets the size, in pixels, of the tooltip arrow.
`void`	`setCornerRadius(int cornerRadius)`	Sets the radius of tooltip corner curves.
`void`	`setCornerRadius(BarBorderRadius cornerRadius)`	Sets the radius of tooltip corner curves.
`void`	`setDisplayColors(boolean displayColors)`	If `true`, color boxes are shown in the tooltip.
`void`	`setEnabled(boolean enabled)`	Sets `true` if tooltips are enabled.
`void`	`setFooterAlign(TextAlign align)`	Sets the footer alignment.
`void`	`setFooterColor(String color)`	Sets the footer font color.
`void`	`setFooterColor(IsColor color)`	Sets the footer font color.
`void`	`setFooterMarginTop(int footerMarginTop)`	Sets the margin to add before drawing the footer.
`void`	`setFooterSpacing(int footerSpacing)`	Sets the spacing to add to top and bottom of each footer line.
`void`	`setIntersect(boolean intersect)`	if `true`, the only applies when the mouse position intersects an item on the chart.
`void`	`setMode(String name)`	Sets which elements appear in the interaction.
`void`	`setMode(IsInteractionMode mode)`	Sets which elements appear in the interaction.
`void`	`setMultiKeyBackground(String multiKeyBackground)`	Sets the color to draw behind the colored boxes when multiple items are in the tooltip.
`void`	`setMultiKeyBackground(IsColor multiKeyBackground)`	Sets the color to draw behind the colored boxes when multiple items are in the tooltip.
`void`	`setPosition(IsTooltipPosition position)`	Sets the mode for positioning the tooltip.
`default void`	`setRtl(boolean rtl)`	Sets `true` for rendering the tooltips from right to left.
`default void`	`setTextDirection(TextDirection textDirection)`	Sets the text direction of the tooltips that will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas.
`void`	`setTitleAlign(TextAlign align)`	Sets the title alignment.
`void`	`setTitleColor(String color)`	Sets the title font color.
`void`	`setTitleColor(IsColor color)`	Sets the title font color.
`void`	`setTitleMarginBottom(int titleMarginBottom)`	Sets the margin to add on bottom of title section.
`void`	`setTitleSpacing(int titleSpacing)`	Sets the spacing to add to top and bottom of each title line.
`void`	`setUsePointStyle(boolean usePointStyle)`	Sets if to use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight).
`void`	`setXAlign(TooltipAlign align)`	Sets the alignment of the tooltip caret in the X direction.
`void`	`setYAlign(TooltipAlign align)`	Sets the alignment of the tooltip caret in the Y direction.

Methods inherited from class org.pepstock.charba.client.options.AbstractModel
getDefaultValues, getParent, loadPadding, setCallbackToModel, setCallbackToModel, setEventToModel

Methods inherited from class org.pepstock.charba.client.commons.AbstractNode
checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkAndGetColor, checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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

Methods inherited from interface org.pepstock.charba.client.options.HasAnimationOptions
getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

Methods inherited from interface org.pepstock.charba.client.options.HasEvents
getEvents, setEvents, setEvents

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultTooltips
getMode, isIntersect

- Method Detail
  - getBoxHandler
```
public org.pepstock.charba.client.options.BoxHandler getBoxHandler()
```
  - getEventsOptionHandler
```
public EventsOptionHandler getEventsOptionHandler()
```
    Description copied from interface: HasEvents
    
    Returns a event handler handler instance to use in the default methods of this interface.
    
    Specified by:
    
    getEventsOptionHandler in interface HasEvents
    
    Returns:
    
    a event handler handler instance
  - getTextDirectionHandler
```
public org.pepstock.charba.client.options.TextDirectionHandler getTextDirectionHandler()
```
  - getAnimationContainer
```
public AnimationContainer getAnimationContainer()
```
    Description copied from interface: HasAnimationOptions
    
    Returns an animation container instance to use in the default methods of this interface.
    
    Specified by:
    
    getAnimationContainer in interface HasAnimationOptions
    
    Returns:
    
    an animation container instance
  - getCallbacks
```
public TooltipsCallbacks getCallbacks()
```
    Returns the callbacks element.
    
    Returns:
    
    the callbacks
  - getPadding
```
public Padding getPadding()
```
    Returns the padding element.
    
    Specified by:
    
    getPadding in interface IsDefaultTooltips
    
    Returns:
    
    the padding
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets true if tooltips are enabled.
    
    Parameters:
    
    enabled - true if tooltips are enabled.
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if tooltips are enabled.
    
    Specified by:
    
    isEnabled in interface IsDefaultTooltips
    
    Returns:
    
    true if tooltips are enabled.
  - setPosition
```
public void setPosition(IsTooltipPosition position)
```
    Sets the mode for positioning the tooltip.
    
    Parameters:
    
    position - the mode for positioning the tooltip.
  - getPosition
```
public IsTooltipPosition getPosition()
```
    Returns the mode for positioning the tooltip.
    
    Specified by:
    
    getPosition in interface IsDefaultTooltips
    
    Returns:
    
    mode for positioning the tooltip.
  - setBackgroundColor
```
public void setBackgroundColor(IsColor backgroundColor)
```
    Sets the background color of the tooltip.
    
    Parameters:
    
    backgroundColor - background color of the tooltip.
  - setBackgroundColor
```
public void setBackgroundColor(String backgroundColor)
```
    Sets the background color of the tooltip.
    
    Parameters:
    
    backgroundColor - background color of the tooltip.
  - getBackgroundColorAsString
```
public String getBackgroundColorAsString()
```
    Returns the background color of the tooltip.
    
    Specified by:
    
    getBackgroundColorAsString in interface IsDefaultTooltips
    
    Returns:
    
    background color of the tooltip.
  - getBackgroundColor
```
public IsColor getBackgroundColor()
```
    Returns the background color of the tooltip.
    
    Returns:
    
    background color of the tooltip.
  - setXAlign
```
public void setXAlign(TooltipAlign align)
```
    Sets the alignment of the tooltip caret in the X direction.
    
    Parameters:
    
    align - the alignment of the tooltip caret in the X direction.
  - getXAlign
```
public TooltipAlign getXAlign()
```
    Returns the alignment of the tooltip caret in the X direction.
    
    Specified by:
    
    getXAlign in interface IsDefaultTooltips
    
    Returns:
    
    the alignment of the tooltip caret in the X direction
  - setYAlign
```
public void setYAlign(TooltipAlign align)
```
    Sets the alignment of the tooltip caret in the Y direction.
    
    Parameters:
    
    align - the alignment of the tooltip caret in the Y direction.
  - getYAlign
```
public TooltipAlign getYAlign()
```
    Returns the alignment of the tooltip caret in the Y direction.
    
    Specified by:
    
    getYAlign in interface IsDefaultTooltips
    
    Returns:
    
    the alignment of the tooltip caret in the Y direction
  - getTitleFont
```
public Font getTitleFont()
```
    Returns the title font element.
    
    Specified by:
    
    getTitleFont in interface IsDefaultTooltips
    
    Returns:
    
    the font
  - setTitleColor
```
public void setTitleColor(IsColor color)
```
    Sets the title font color.
    
    Parameters:
    
    color - title font color.
  - setTitleColor
```
public void setTitleColor(String color)
```
    Sets the title font color.
    
    Parameters:
    
    color - title font color.
  - getTitleColorAsString
```
public String getTitleColorAsString()
```
    Returns the title font color as string.
    
    Specified by:
    
    getTitleColorAsString in interface IsDefaultTooltips
    
    Returns:
    
    title font color as string
  - getTitleColor
```
public IsColor getTitleColor()
```
    Returns the title font color.
    
    Returns:
    
    title font color
  - setTitleAlign
```
public void setTitleAlign(TextAlign align)
```
    Sets the title alignment.
    
    Parameters:
    
    align - title alignment.
  - getTitleAlign
```
public TextAlign getTitleAlign()
```
    Returns the title alignment.
    
    Specified by:
    
    getTitleAlign in interface IsDefaultTooltips
    
    Returns:
    
    title alignment.
  - setTitleSpacing
```
public void setTitleSpacing(int titleSpacing)
```
    Sets the spacing to add to top and bottom of each title line.
    
    Parameters:
    
    titleSpacing - spacing to add to top and bottom of each title line.
  - getTitleSpacing
```
public int getTitleSpacing()
```
    Returns the spacing to add to top and bottom of each title line.
    
    Specified by:
    
    getTitleSpacing in interface IsDefaultTooltips
    
    Returns:
    
    spacing to add to top and bottom of each title line.
  - setTitleMarginBottom
```
public void setTitleMarginBottom(int titleMarginBottom)
```
    Sets the margin to add on bottom of title section.
    
    Parameters:
    
    titleMarginBottom - margin to add on bottom of title section.
  - getTitleMarginBottom
```
public int getTitleMarginBottom()
```
    Returns the margin to add on bottom of title section.
    
    Specified by:
    
    getTitleMarginBottom in interface IsDefaultTooltips
    
    Returns:
    
    margin to add on bottom of title section.
  - getBodyFont
```
public Font getBodyFont()
```
    Returns the body font element.
    
    Specified by:
    
    getBodyFont in interface IsDefaultTooltips
    
    Returns:
    
    the font
  - setBodyColor
```
public void setBodyColor(IsColor color)
```
    Sets the body font color.
    
    Parameters:
    
    color - body font color.
  - setBodyColor
```
public void setBodyColor(String color)
```
    Sets the body font color.
    
    Parameters:
    
    color - body font color.
  - getBodyColorAsString
```
public String getBodyColorAsString()
```
    Returns the body font color as string.
    
    Specified by:
    
    getBodyColorAsString in interface IsDefaultTooltips
    
    Returns:
    
    body font color as string
  - getBodyColor
```
public IsColor getBodyColor()
```
    Returns the body font color.
    
    Returns:
    
    body font color
  - setBodyAlign
```
public void setBodyAlign(TextAlign align)
```
    Sets the body alignment.
    
    Parameters:
    
    align - body alignment.
  - getBodyAlign
```
public TextAlign getBodyAlign()
```
    Returns the body alignment.
    
    Specified by:
    
    getBodyAlign in interface IsDefaultTooltips
    
    Returns:
    
    body alignment.
  - setBodySpacing
```
public void setBodySpacing(int bodySpacing)
```
    Sets the spacing to add to top and bottom of each tooltip item.
    
    Parameters:
    
    bodySpacing - spacing to add to top and bottom of each tooltip item.
  - getBodySpacing
```
public int getBodySpacing()
```
    Returns the spacing to add to top and bottom of each tooltip item.
    
    Specified by:
    
    getBodySpacing in interface IsDefaultTooltips
    
    Returns:
    
    spacing to add to top and bottom of each tooltip item.
  - getFooterFont
```
public Font getFooterFont()
```
    Returns the footer font element.
    
    Specified by:
    
    getFooterFont in interface IsDefaultTooltips
    
    Returns:
    
    the font
  - setFooterColor
```
public void setFooterColor(IsColor color)
```
    Sets the footer font color.
    
    Parameters:
    
    color - footer font color.
  - setFooterColor
```
public void setFooterColor(String color)
```
    Sets the footer font color.
    
    Parameters:
    
    color - footer font color.
  - getFooterColorAsString
```
public String getFooterColorAsString()
```
    Returns the footer font color as string.
    
    Specified by:
    
    getFooterColorAsString in interface IsDefaultTooltips
    
    Returns:
    
    footer font color as string
  - getFooterColor
```
public IsColor getFooterColor()
```
    Returns the footer font color.
    
    Returns:
    
    footer font color
  - setFooterAlign
```
public void setFooterAlign(TextAlign align)
```
    Sets the footer alignment.
    
    Parameters:
    
    align - footer alignment.
  - getFooterAlign
```
public TextAlign getFooterAlign()
```
    Returns the body alignment.
    
    Specified by:
    
    getFooterAlign in interface IsDefaultTooltips
    
    Returns:
    
    footer alignment.
  - setFooterSpacing
```
public void setFooterSpacing(int footerSpacing)
```
    Sets the spacing to add to top and bottom of each footer line.
    
    Parameters:
    
    footerSpacing - spacing to add to top and bottom of each footer line.
  - getFooterSpacing
```
public int getFooterSpacing()
```
    Returns the spacing to add to top and bottom of each footer line.
    
    Specified by:
    
    getFooterSpacing in interface IsDefaultTooltips
    
    Returns:
    
    spacing to add to top and bottom of each footer line.
  - setFooterMarginTop
```
public void setFooterMarginTop(int footerMarginTop)
```
    Sets the margin to add before drawing the footer.
    
    Parameters:
    
    footerMarginTop - margin to add before drawing the footer.
  - getFooterMarginTop
```
public int getFooterMarginTop()
```
    Returns the margin to add before drawing the footer.
    
    Specified by:
    
    getFooterMarginTop in interface IsDefaultTooltips
    
    Returns:
    
    margin to add before drawing the footer.
  - setCaretPadding
```
public void setCaretPadding(int caretPadding)
```
    Sets the extra distance to move the end of the tooltip arrow away from the tooltip point.
    
    Parameters:
    
    caretPadding - extra distance to move the end of the tooltip arrow away from the tooltip point.
  - getCaretPadding
```
public int getCaretPadding()
```
    Returns the extra distance to move the end of the tooltip arrow away from the tooltip point.
    
    Specified by:
    
    getCaretPadding in interface IsDefaultTooltips
    
    Returns:
    
    extra distance to move the end of the tooltip arrow away from the tooltip point.
  - setCaretSize
```
public void setCaretSize(int caretSize)
```
    Sets the size, in pixels, of the tooltip arrow.
    
    Parameters:
    
    caretSize - size, in pixels, of the tooltip arrow.
  - getCaretSize
```
public int getCaretSize()
```
    Returns the size, in pixels, of the tooltip arrow.
    
    Specified by:
    
    getCaretSize in interface IsDefaultTooltips
    
    Returns:
    
    size, in pixels, of the tooltip arrow.
  - setCornerRadius
```
public void setCornerRadius(int cornerRadius)
```
    Sets the radius of tooltip corner curves.
    
    Parameters:
    
    cornerRadius - radius of tooltip corner curves.
  - setCornerRadius
```
public void setCornerRadius(BarBorderRadius cornerRadius)
```
    Sets the radius of tooltip corner curves.
    
    Parameters:
    
    cornerRadius - radius of tooltip corner curves.
  - getCornerRadius
```
public int getCornerRadius()
```
    Returns the radius of tooltip corner curves.
    
    Specified by:
    
    getCornerRadius in interface IsDefaultTooltips
    
    Returns:
    
    radius of tooltip corner curves.
  - getCornerRadiusAsObject
```
public BarBorderRadius getCornerRadiusAsObject()
```
    Returns the radius of tooltip corner curves.
    
    Returns:
    
    radius of tooltip corner curves.
  - setMultiKeyBackground
```
public void setMultiKeyBackground(IsColor multiKeyBackground)
```
    Sets the color to draw behind the colored boxes when multiple items are in the tooltip.
    
    Parameters:
    
    multiKeyBackground - color to draw behind the colored boxes when multiple items are in the tooltip.
  - setMultiKeyBackground
```
public void setMultiKeyBackground(String multiKeyBackground)
```
    Sets the color to draw behind the colored boxes when multiple items are in the tooltip.
    
    Parameters:
    
    multiKeyBackground - color to draw behind the colored boxes when multiple items are in the tooltip.
  - getMultiKeyBackgroundAsString
```
public String getMultiKeyBackgroundAsString()
```
    Returns the color to draw behind the colored boxes when multiple items are in the tooltip.
    
    Specified by:
    
    getMultiKeyBackgroundAsString in interface IsDefaultTooltips
    
    Returns:
    
    color to draw behind the colored boxes when multiple items are in the tooltip.
  - getMultiKeyBackground
```
public IsColor getMultiKeyBackground()
```
    Returns the color to draw behind the colored boxes when multiple items are in the tooltip.
    
    Returns:
    
    color to draw behind the colored boxes when multiple items are in the tooltip.
  - setDisplayColors
```
public void setDisplayColors(boolean displayColors)
```
    If true, color boxes are shown in the tooltip.
    
    Parameters:
    
    displayColors - if true, color boxes are shown in the tooltip.
  - isDisplayColors
```
public boolean isDisplayColors()
```
    If true, color boxes are shown in the tooltip.
    
    Specified by:
    
    isDisplayColors in interface IsDefaultTooltips
    
    Returns:
    
    if true, color boxes are shown in the tooltip.
  - setBorderColor
```
public void setBorderColor(IsColor borderColor)
```
    Sets the color of the border.
    
    Parameters:
    
    borderColor - color of the border.
  - setBorderColor
```
public void setBorderColor(String borderColor)
```
    Sets the color of the border.
    
    Parameters:
    
    borderColor - color of the border.
  - getBorderColorAsString
```
public String getBorderColorAsString()
```
    Returns the color of the border.
    
    Specified by:
    
    getBorderColorAsString in interface IsDefaultTooltips
    
    Returns:
    
    color of the border.
  - getBorderColor
```
public IsColor getBorderColor()
```
    Returns the color of the border.
    
    Returns:
    
    color of the border.
  - setBorderWidth
```
public void setBorderWidth(int borderWidth)
```
    Sets the size of the border.
    
    Parameters:
    
    borderWidth - size of the border.
  - getBorderWidth
```
public int getBorderWidth()
```
    Returns the size of the border.
    
    Specified by:
    
    getBorderWidth in interface IsDefaultTooltips
    
    Returns:
    
    size of the border.
  - setUsePointStyle
```
public void setUsePointStyle(boolean usePointStyle)
```
    Sets if to use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight).
    
    Parameters:
    
    usePointStyle - true if to use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight)
  - isUsePointStyle
```
public boolean isUsePointStyle()
```
    Returns if to use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight).
    
    Specified by:
    
    isUsePointStyle in interface IsDefaultTooltips
    
    Returns:
    
    true if to use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between boxWidth and boxHeight)
  - setBoxPadding
```
public void setBoxPadding(int boxPadding)
```
    Sets the padding between the color box and the text.
    
    Parameters:
    
    boxPadding - padding between the color box and the text
  - getBoxPadding
```
public int getBoxPadding()
```
    Returns the padding between the color box and the text.
    
    Specified by:
    
    getBoxPadding in interface IsDefaultTooltips
    
    Returns:
    
    padding between the color box and the text
  - setRtl
```
public default void setRtl(boolean rtl)
```
    Sets true for rendering the tooltips from right to left.
    
    Parameters:
    
    rtl - true for rendering the tooltips from right to left
  - isRtl
```
public default boolean isRtl()
```
    Description copied from interface: IsDefaultTextDirectionHandler
    
    Returns true for rendering the object from right to left.
    
    Specified by:
    
    isRtl in interface IsDefaultTextDirectionHandler
    
    Returns:
    
    true for rendering the object from right to left.
  - setTextDirection
```
public default void setTextDirection(TextDirection textDirection)
```
    Sets the text direction of the tooltips that will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas.
    
    Parameters:
    
    textDirection - the text direction of the tooltips.
  - getTextDirection
```
public default TextDirection getTextDirection()
```
    Description copied from interface: IsDefaultTextDirectionHandler
    
    Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
    
    Specified by:
    
    getTextDirection in interface IsDefaultTextDirectionHandler
    
    Returns:
    
    the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas
  - setBoxWidth
```
public default void setBoxWidth(int boxWidth)
```
    Sets the width of colored box.
    
    Parameters:
    
    boxWidth - width of colored box.
  - getBoxWidth
```
public default int getBoxWidth()
```
    Returns the width of colored box.
    
    Specified by:
    
    getBoxWidth in interface IsDefaultBoxHandler
    
    Returns:
    
    width of colored box.
  - setBoxHeight
```
public default void setBoxHeight(int boxHeight)
```
    Sets the height of colored box.
    
    Parameters:
    
    boxHeight - width of colored box.
  - getBoxHeight
```
public default int getBoxHeight()
```
    Returns the height of colored box.
    
    Specified by:
    
    getBoxHeight in interface IsDefaultBoxHandler
    
    Returns:
    
    height of colored box.
  - setMode
```
public final void setMode(String name)
```
    Sets which elements appear in the interaction.
    
    Parameters:
    
    name - which elements appear in the interaction.
  - setMode
```
public final void setMode(IsInteractionMode mode)
```
    Sets which elements appear in the interaction.
    
    Parameters:
    
    mode - which elements appear in the interaction.
  - getMode
```
public final IsInteractionMode getMode()
```
    Returns which elements appear in the interaction.
    
    Returns:
    
    which elements appear in the interaction.
  - setIntersect
```
public final void setIntersect(boolean intersect)
```
    if true, the only applies when the mouse position intersects an item on the chart.
    
    Parameters:
    
    intersect - if true, the mode only applies when the mouse position intersects an item on the chart.
  - isIntersect
```
public final boolean isIntersect()
```
    if true, the mode only applies when the mouse position intersects an item on the chart.
    
    Returns:
    
    if true, the mode only applies when the mouse position intersects an item on the chart.

Class Tooltips

Method Summary

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.pepstock.charba.client.options.HasAnimationOptions

Methods inherited from interface org.pepstock.charba.client.options.HasEvents

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultTooltips

Method Detail

getBoxHandler

getEventsOptionHandler

getTextDirectionHandler

getAnimationContainer

getCallbacks

getPadding

setEnabled

isEnabled

setPosition

getPosition

setBackgroundColor

setBackgroundColor

getBackgroundColorAsString

getBackgroundColor

setXAlign

getXAlign

setYAlign

getYAlign

getTitleFont

setTitleColor

setTitleColor

getTitleColorAsString

getTitleColor

setTitleAlign

getTitleAlign

setTitleSpacing

getTitleSpacing

setTitleMarginBottom

getTitleMarginBottom

getBodyFont

setBodyColor

setBodyColor

getBodyColorAsString

getBodyColor

setBodyAlign

getBodyAlign

setBodySpacing

getBodySpacing

getFooterFont

setFooterColor

setFooterColor

getFooterColorAsString

getFooterColor

setFooterAlign

getFooterAlign

setFooterSpacing

getFooterSpacing

setFooterMarginTop

getFooterMarginTop

setCaretPadding

getCaretPadding

setCaretSize

getCaretSize

setCornerRadius

setCornerRadius

getCornerRadius

getCornerRadiusAsObject

setMultiKeyBackground

setMultiKeyBackground

getMultiKeyBackgroundAsString

getMultiKeyBackground

setDisplayColors

isDisplayColors

setBorderColor

setBorderColor

getBorderColorAsString

getBorderColor

setBorderWidth

getBorderWidth

setUsePointStyle