tooltip

Configures tooltips.

Type: Object

A tooltip is a miniature rectangle displaying the value of a gauge's indicator. A tooltip appears when the end-user hovers the cursor over an indicator. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

Show Example:
jQuery

In this example, a number of the tooltip options are changed. The tooltip value is displayed in a currency format with the precision of 2. In addition, the font size and weight options are changed. To see the tooltip, hover over the red range bar.


                                    

                                    

arrowLength

Specifies the length of the tooltip's arrow in pixels.

Type: Number
Default Value: 10

Show Example:
jQuery

In this example, tooltips have a 5-pixel arrow.


                                    

                                    

border

Specifies the appearance of the tooltip's border.

Type: Object

Show Example:
jQuery

In this example, several options of the tooltip's border are changed.


                                    

                                    

color

Specifies the color of tooltips.

Type: String
Default Value: '#ffffff'

This option supports the following colors.

This option sets one color for all tooltips in the widget. To specify a color for a particular tooltip, use the customizeTooltip option.

Show Example:
jQuery

In this example, tooltips are painted in 'powderblue' using the color option.


                                    

                                    

container

Specifies the container to draw tooltips inside of it.

Default Value: undefined

By default, tooltips are shown within the body DOM element. Use this option if you need to specify another container for tooltips.

customizeTooltip

Allows you to change the appearance of specified tooltips.

Type: function(scaleValue)
Function parameters:
scaleValue: Object
The scale value to be displayed in the tooltip.
Object structure:
value: Number
The scale value.
valueText: String
The scale value with applied format.
Return Value: Object
Settings to be applied to the tooltip.
Default Value: undefined

This option should be assigned a function returning a specific object. The following fields can be specified in this object.

  • color
    Specifies the color of a tooltip.

  • borderColor
    Specifies the color of the tooltip's border.

  • fontColor
    Specifies the color of the tooltip's text.

  • text
    Specifies the text displayed by a tooltip.

  • html
    Specifies the HTML markup displayed by a tooltip. [note]If you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.

When implementing the function for this option, you can access the scale value represented by a tooltip. This value can be accessed using the fields of the object that is passed as the function's parameter. Alternatively, you can use the this object within the function. This object has the same structure as the object passed as a parameter.

To get general information on data formatting, refer to the Data Formatting topic.

Show Example:
jQuery

In this example, if a tooltip represents a value greater than 50, it is painted in 'bisque'.


                                    

                                    

enabled

Enables tooltips.

Type: Boolean
Default Value: false

Show Example:
jQuery

Use the check box under the gauge to enable/disable tooltips. Hover over the green range bar to see the changes.


                                    

                                    

font

Specifies the font of the text displayed by a tooltip.

Type: Object

Show Example:
jQuery

In this example, the font of the tooltip's text is changed.


                                    

                                    

format

Specifies the format of the value displayed by a tooltip.

Type: Format
Default Value: undefined
NOTE
DevExtreme widgets provide a wide choice of predefined formats. If you are, however, going to use custom formats, link the Globalize library to your project. Learn how to do this from the Installation topic.
See Also
  • format - provides a comprehensive overview of formatting capabilities.
  • Data Formatting - shows how to apply formatting to various widget elements.
Show Example:
jQuery

In this example, the tooltip value is displayed in a thousands format with a precision of 2.


                                    

                                    

opacity

Specifies the opacity of tooltips.

Type: Number
Default Value: undefined

Show Example:
jQuery

In this example, tooltips are displayed with a 0.45 opacity.


                                    

                                    

paddingLeftRight

Generates space on the left and the right of the text displayed by a tooltip.

Type: Number
Default Value: 18

TooltipPadding ChartJS

paddingTopBottom

Generates space above and below the text displayed by a tooltip.

Type: Number
Default Value: 15

TooltipPadding ChartJS

precision

Deprecated

Use the tooltip | format | precision option instead.

Specifies the precision of formatted values in a tooltip.

Type: Number
Default Value: undefined

shadow

Specifies the appearance of the tooltip's shadow.

Type: Object

zIndex

Specifies the z-index of tooltips.

Type: Number
Default Value: undefined

If the widget container has the CSS z-index property specified and tooltips are displayed incorrectly, configure the z-index of the tooltips using this option.