JavaScript/jQuery BarGauge - Tooltip

Configures tooltips.

import { Tooltip } from "devextreme/viz/bar_gauge"

contentTemplate

Specifies a custom template for a tooltip.

Type:

template

| undefined

Function parameters:

scaleValue:

Object

Information on the bar value.

Object structure:

Name	Type	Description
index	Number	The index of the bar being pressed or hovered over. 0 for the bar closest to the gauge's center, 1 for the bar over it, etc.
value	Number	The raw value.
valueText	String	The formatted value converted to a string.

Name

Type

Description

index

Number

The index of the bar being pressed or hovered over. 0 for the bar closest to the gauge's center, 1 for the bar over it, etc.

value

Number

The raw value.

valueText

String

The formatted value converted to a string.

element:

HTMLElement | jQuery

The tooltip's container. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

Element

jQuery

One of the following:

HTML markup as a string
A DOM node
A DOM node wrapped in a jQuery element

Default Value: undefined

customizeTooltip

Allows you to change tooltip appearance.

Type:

Function

| undefined

Function parameters:

scaleValue:

Object

Information on the bar value.

Object structure:

Name	Type	Description
index	Number	A zero-based index of the hovered bar. The closer this bar is to the gauge's center, the greater its index.
value	Number	The raw value.
valueText	String	The formatted value converted to a string.

Name

Type

Description

index

Number

A zero-based index of the hovered bar. The closer this bar is to the gauge's center, the greater its index.

value

Number

The raw value.

valueText

String

The formatted value converted to a string.