Package software.xdev.chartjs.model.options

Class Tooltip

java.lang.Object

software.xdev.chartjs.model.options.Tooltip

public class Tooltip
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	backgroundColor
protected Object	bodyFontColor
protected String	bodyFontFamily
protected Integer	bodyFontSize
protected FontStyle	bodyFontStyle
protected Integer	bodySpacing
protected Callbacks	callbacks
protected Integer	caretSize
protected Integer	cornerRadius
protected Boolean	enabled
protected JavaScriptFunction	external
protected Object	footerFontColor
protected String	footerFontFamily
protected Integer	footerFontSize
protected FontStyle	footerFontStyle
protected Integer	footerMarginTop
protected Integer	footerSpacing
protected JavaScriptFunction	itemSort
protected String	mode
protected Object	multiKeyBackground
protected Object	titleFontColor
protected String	titleFontFamily
protected Integer	titleFontSize
protected FontStyle	titleFontStyle
protected Integer	titleMarginBottom
protected Integer	titleSpacing
protected Integer	xPadding
protected Integer	yPadding

Constructor Summary

Constructors

Constructor	Description
Tooltip()

Method Summary

Modifier and Type	Method	Description
Object	getBackgroundColor()
Object	getBodyFontColor()
String	getBodyFontFamily()
Integer	getBodyFontSize()
FontStyle	getBodyFontStyle()
Integer	getBodySpacing()
Callbacks	getCallbacks()
Integer	getCaretSize()
Integer	getCornerRadius()
Boolean	getEnabled()
JavaScriptFunction	getExternal()
Object	getFooterFontColor()
String	getFooterFontFamily()
Integer	getFooterFontSize()
FontStyle	getFooterFontStyle()
Integer	getFooterMarginTop()
Integer	getFooterSpacing()
JavaScriptFunction	getItemSort()
String	getMode()
Object	getMultiKeyBackground()
Object	getTitleFontColor()
String	getTitleFontFamily()
Integer	getTitleFontSize()
FontStyle	getTitleFontStyle()
Integer	getTitleMarginBottom()
Integer	getTitleSpacing()
Integer	getXPadding()
Integer	getYPadding()
Tooltip	setBackgroundColor(Object backgroundColor)	Background color of the tooltip
Tooltip	setBodyFontColor(Object bodyFontColor)	Font color for tooltip items.
Tooltip	setBodyFontFamily(String bodyFontFamily)	Font family for tooltip items inherited from global font family
Tooltip	setBodyFontSize(Integer bodyFontSize)	Font size for tooltip items inherited from global font size
Tooltip	setBodyFontStyle(FontStyle bodyFontStyle)
Tooltip	setBodySpacing(Integer bodySpacing)	Spacing to add to top and bottom of each tooltip item
Tooltip	setCallbacks(Callbacks callbacks)	See the callbacks section below
Tooltip	setCaretSize(Integer caretSize)	Size, in px, of the tooltip arrow
Tooltip	setCornerRadius(Integer cornerRadius)	Radius of tooltip corner curves
Tooltip	setEnabled(Boolean enabled)	Are tooltips enabled
Tooltip	setExternal(JavaScriptFunction external)	See section below
Tooltip	setFooterFontColor(Object footerFontColor)	Font color for tooltip footer.
Tooltip	setFooterFontFamily(String footerFontFamily)	Font family for tooltip footer inherited from global font family.
Tooltip	setFooterFontSize(Integer footerFontSize)	Font size for tooltip footer inherited from global font size.
Tooltip	setFooterFontStyle(FontStyle footerFontStyle)	Font style for tooltip footer.
Tooltip	setFooterMarginTop(Integer footerMarginTop)	Margin to add before drawing the footer
Tooltip	setFooterSpacing(Integer footerSpacing)	Spacing to add to top and bottom of each footer line.
Tooltip	setItemSort(JavaScriptFunction itemSort)	Allows sorting of tooltip items.
Tooltip	setMode(String mode)	Sets which elements appear in the tooltip.
Tooltip	setMultiKeyBackground(Object multiKeyBackground)	Color to draw behind the colored boxes when multiple items are in the tooltip
Tooltip	setTitleFontColor(Object titleFontColor)	Font color for tooltip title
Tooltip	setTitleFontFamily(String titleFontFamily)	Font family for tooltip title inherited from global font family
Tooltip	setTitleFontSize(Integer titleFontSize)	Font size for tooltip title inherited from global font size
Tooltip	setTitleFontStyle(FontStyle titleFontStyle)
Tooltip	setTitleMarginBottom(Integer titleMarginBottom)	Margin to add on bottom of title section
Tooltip	setTitleSpacing(Integer titleSpacing)	Spacing to add to top and bottom of each title line.
Tooltip	setXPadding(Integer xPadding)	Padding to add on left and right of tooltip
Tooltip	setYPadding(Integer yPadding)	Padding to add on top and bottom of tooltip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

enabled

protected Boolean enabled

external

protected JavaScriptFunction external

mode

protected String mode

itemSort

protected JavaScriptFunction itemSort

backgroundColor

protected Object backgroundColor

titleFontFamily

protected String titleFontFamily

titleFontSize

protected Integer titleFontSize

titleFontStyle

protected FontStyle titleFontStyle

titleFontColor

protected Object titleFontColor

titleSpacing

protected Integer titleSpacing

titleMarginBottom

protected Integer titleMarginBottom

bodyFontFamily

protected String bodyFontFamily

bodyFontSize

protected Integer bodyFontSize

bodyFontStyle

protected FontStyle bodyFontStyle

bodyFontColor

protected Object bodyFontColor

bodySpacing

protected Integer bodySpacing

footerFontFamily

protected String footerFontFamily

footerFontSize

protected Integer footerFontSize

footerFontStyle

protected FontStyle footerFontStyle

footerFontColor

protected Object footerFontColor

footerSpacing

protected Integer footerSpacing

footerMarginTop

protected Integer footerMarginTop

xPadding

protected Integer xPadding

yPadding

protected Integer yPadding

caretSize

protected Integer caretSize

cornerRadius

protected Integer cornerRadius

multiKeyBackground

protected Object multiKeyBackground

callbacks

protected Callbacks callbacks

Constructor Details

Tooltip

public Tooltip()

Method Details

getEnabled

public Boolean getEnabled()

See Also:

• setEnabled(Boolean)

setEnabled

public Tooltip setEnabled(Boolean enabled)

Are tooltips enabled

Default true

getExternal

public JavaScriptFunction getExternal()

See Also:

• setExternal(JavaScriptFunction)

setExternal

public Tooltip setExternal(JavaScriptFunction external)

See section below

Default null

getMode

public String getMode()

See Also:

• setMode(String)

setMode

public Tooltip setMode(String mode)

Sets which elements appear in the tooltip. Acceptable options are 'single', 'label' or 'x-axis'. single highlights the closest element. label highlights elements in all datasets at the same X value. 'x-axis' also highlights elements in all datasets at the same X value, but activates when hovering anywhere within the vertical slice of the x-axis representing that X value.

Default 'single'

getItemSort

public JavaScriptFunction getItemSort()

See Also:

• setItemSort(JavaScriptFunction)

setItemSort

public Tooltip setItemSort(JavaScriptFunction itemSort)

Allows sorting of tooltip items. Must implement a function that can be passed to Array.prototype.sort

Default undefined

getBackgroundColor

public Object getBackgroundColor()

See Also:

• setBackgroundColor(Object)

setBackgroundColor

public Tooltip setBackgroundColor(Object backgroundColor)

Background color of the tooltip

Default 'rgba(0,0,0,0.8)'

getTitleFontFamily

public String getTitleFontFamily()

See Also:

• setTitleFontFamily(String)

setTitleFontFamily

public Tooltip setTitleFontFamily(String titleFontFamily)

Font family for tooltip title inherited from global font family

Default "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

getTitleFontSize

public Integer getTitleFontSize()

See Also:

• setTitleFontSize(Integer)

setTitleFontSize

public Tooltip setTitleFontSize(Integer titleFontSize)

Font size for tooltip title inherited from global font size

Default 12

getTitleFontStyle

public FontStyle getTitleFontStyle()

See Also:

• setTitleFontStyle(FontStyle)

setTitleFontStyle

public Tooltip setTitleFontStyle(FontStyle titleFontStyle)

Default "bold"

getTitleFontColor

public Object getTitleFontColor()

See Also:

• setTitleFontColor(Object)

setTitleFontColor

public Tooltip setTitleFontColor(Object titleFontColor)

Font color for tooltip title

Default "#fff"

getTitleSpacing

public Integer getTitleSpacing()

See Also:

• setTitleSpacing(Integer)

setTitleSpacing

public Tooltip setTitleSpacing(Integer titleSpacing)

Spacing to add to top and bottom of each title line.

Default 2

getTitleMarginBottom

public Integer getTitleMarginBottom()

See Also:

• setTitleMarginBottom(Integer)

setTitleMarginBottom

public Tooltip setTitleMarginBottom(Integer titleMarginBottom)

Margin to add on bottom of title section

Default 6

getBodyFontFamily

public String getBodyFontFamily()

See Also:

• setBodyFontFamily(String)

setBodyFontFamily

public Tooltip setBodyFontFamily(String bodyFontFamily)

Font family for tooltip items inherited from global font family

Default "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

getBodyFontSize

public Integer getBodyFontSize()

See Also:

• setBodyFontSize(Integer)

setBodyFontSize

public Tooltip setBodyFontSize(Integer bodyFontSize)

Font size for tooltip items inherited from global font size

Default 12

getBodyFontStyle

public FontStyle getBodyFontStyle()

See Also:

• setBodyFontStyle(FontStyle)

setBodyFontStyle

public Tooltip setBodyFontStyle(FontStyle bodyFontStyle)

Default "normal"

getBodyFontColor

public Object getBodyFontColor()

See Also:

• setBodyFontColor(Object)

setBodyFontColor

public Tooltip setBodyFontColor(Object bodyFontColor)

Font color for tooltip items.

Default "#fff"

getBodySpacing

public Integer getBodySpacing()

See Also:

• setBodySpacing(Integer)

setBodySpacing

public Tooltip setBodySpacing(Integer bodySpacing)

Spacing to add to top and bottom of each tooltip item

Default 2

getFooterFontFamily

public String getFooterFontFamily()

See Also:

• setFooterFontFamily(String)

setFooterFontFamily

public Tooltip setFooterFontFamily(String footerFontFamily)

Font family for tooltip footer inherited from global font family.

Default "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

getFooterFontSize

public Integer getFooterFontSize()

See Also:

• setFooterFontSize(Integer)

setFooterFontSize

public Tooltip setFooterFontSize(Integer footerFontSize)

Font size for tooltip footer inherited from global font size.

Default 12

getFooterFontStyle

public FontStyle getFooterFontStyle()

See Also:

• setFooterFontStyle(FontStyle)

setFooterFontStyle

public Tooltip setFooterFontStyle(FontStyle footerFontStyle)

Font style for tooltip footer.

Default "bold"

getFooterFontColor

public Object getFooterFontColor()

See Also:

• setFooterFontColor(Object)

setFooterFontColor

public Tooltip setFooterFontColor(Object footerFontColor)

Font color for tooltip footer.

Default "#fff"

getFooterSpacing

public Integer getFooterSpacing()

See Also:

• setFooterSpacing(Integer)

setFooterSpacing

public Tooltip setFooterSpacing(Integer footerSpacing)

Spacing to add to top and bottom of each footer line.

Default 2

getFooterMarginTop

public Integer getFooterMarginTop()

See Also:

• setFooterMarginTop(Integer)

setFooterMarginTop

public Tooltip setFooterMarginTop(Integer footerMarginTop)

Margin to add before drawing the footer

Default 6

getXPadding

public Integer getXPadding()

See Also:

• setXPadding(Integer)

setXPadding

public Tooltip setXPadding(Integer xPadding)

Padding to add on left and right of tooltip

Default 6

getYPadding

public Integer getYPadding()

See Also:

• setYPadding(Integer)

setYPadding

public Tooltip setYPadding(Integer yPadding)

Padding to add on top and bottom of tooltip

Default 6

getCaretSize

public Integer getCaretSize()

See Also:

• setCaretSize(Integer)

setCaretSize

public Tooltip setCaretSize(Integer caretSize)

Size, in px, of the tooltip arrow

Default 5

getCornerRadius

public Integer getCornerRadius()

See Also:

• setCornerRadius(Integer)

setCornerRadius

public Tooltip setCornerRadius(Integer cornerRadius)

Radius of tooltip corner curves

Default 6

getMultiKeyBackground

public Object getMultiKeyBackground()

See Also:

• setMultiKeyBackground(Object)

setMultiKeyBackground

public Tooltip setMultiKeyBackground(Object multiKeyBackground)

Color to draw behind the colored boxes when multiple items are in the tooltip

Default "#fff"

getCallbacks

public Callbacks getCallbacks()

See Also:

• setCallbacks(Callbacks)

setCallbacks

public Tooltip setCallbacks(Callbacks callbacks)

See the callbacks section below

Default