Vue PieChart - tooltip

Configures tooltips.

Selector: DxTooltip
Type: viz/chart_components/base_chart:BaseChartTooltip

A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

argumentFormat

Formats the point argument before it is displayed in the tooltip. To format the point value, use the format property.

Selector: DxArgumentFormat
Type:

Format

| undefined
Default Value: undefined
See Also
  • format - provides a comprehensive overview of formatting capabilities.
  • Value Formatting - shows how to apply formatting to various UI component elements.

arrowLength

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

Selector: arrow-length
Type:

Number

Default Value: 10

border

Configures a tooltip's border.

Selector: DxBorder
Type:

Object

color

Colors all tooltips.

Type:

String

Default Value: '#ffffff'

This property supports the following colors:

This property sets one color for all tooltips. You can specify a particular tooltip's color in the tooltip.customizeTooltip function.

container

Specifies the container in which to draw tooltips. The default container is the HTML DOM <body> element.

Type:

String

|

HTMLElement | jQuery

| undefined
Default Value: undefined

contentTemplate

Specifies a custom template for a tooltip.

Selector: content-template
Type:

template

Template Data:

Object

Information on the series point being pressed or hovered over.

Default Name: undefined

You can access the following pointInfo object fields:

Field name Description
value The value of the currently hovered point.
valueText The value of the point being hovered over with formatting applied if the format property is specified.
argument The argument value of the point being hovered over.
argumentText The argument value of the point being hovered over with formatting applied if the argumentFormat property is specified.
percent The percent value of the point being hovered over.
percentText The percent value of the point being hovered over with percent precision (optional) applied.
point Information on the point being hovered over. To learn more about the field and methods of the point object, refer to the Point topic.
See Also

cornerRadius

Makes all the tooltip's corners rounded.

Selector: corner-radius
Type:

Number

Default Value: 0, 4 (Fluent, Material)

The following table demonstrates how the corner's curvature depends on the cornerRadius value:

cornerRadius Result
cornerRadius: 0 DevExtreme Chart: tooltip with cornerRadius set to 0
cornerRadius: 15 DevExtreme Chart: tooltip with cornerRadius set to 15
cornerRadius: 35 DevExtreme Chart: tooltip with cornerRadius set to 35

customizeTooltip

Allows you to change tooltip appearance.

Selector: customize-tooltip
Type:

Function

| undefined
Function parameters:
pointInfo:

Object

Information on the series point being pressed or hovered over with the mouse pointer.

Return Value:

Object

The tooltip's text or markup and appearance settings.

Default Value: undefined
Cannot be used in themes.

This property should be assigned a function that returns an object with the following fields:

Field name Description
text The tooltip's text.
html The HTML markup displayed in a tooltip.
The PieChart evaluates the markup. Make sure that it does not contain malicious code. Refer to the following help topic for more information: Potentially Vulnerable API - customizeTooltip.
To use external resources (for example, images) in the markup, specify the size of the area they occupy beforehand.
color The tooltip's color.
fontColor The color of the tooltip's text.
borderColor The color of the tooltip's border.

This function's parameter has the following fields:

Field name Description
originalValue The value of the represented point as it is set in the data source.
value The value of the currently hovered point.
valueText The value of the point being hovered over with formatting applied if the format property is specified.
originalArgument The argument value of the represented point as it is set in the data source.
argument The argument value of the point being hovered over.
argumentText The argument value of the point being hovered over with formatting applied if the argumentFormat property is specified.
seriesName The series name of the point being hovered over.
percent The percent value of the point being hovered over.
percentText The percent value of the point being hovered over with percent precision (optional) applied.
point Information on the point being hovered over. To learn more about the field and methods of the point object, refer to the Point topic.
NOTE
As an alternative to the function’s parameter you can use the this keyword.

View Demo

See Also

enabled

Enables tooltips.

Type:

Boolean

Default Value: false

font

Specifies tooltips' font properties.

Selector: DxFont
Type:

Object

format

Formats a value before it is displayed it in a tooltip.

Selector: DxFormat
Type:

Format

| undefined
Default Value: undefined

See the format section for information on accepted values.

See Also

interactive

Allows users to interact with the tooltip content.

Type:

Boolean

Default Value: false

opacity

Specifies tooltips' transparency.

Type:

Number

| undefined
Default Value: undefined

This property accepts a value from 0 to 1, where 0 makes tooltips completely transparent, and 1 makes them opaque.

paddingLeftRight

Generates an empty space, measured in pixels, between a tooltip's left/right border and its text.

Selector: padding-left-right
Type:

Number

Default Value: 18

DevExtreme HTML5 JavaScript Funnel Tooltips Left-Right Padding

paddingTopBottom

Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text.

Selector: padding-top-bottom
Type:

Number

Default Value: 15

DevExtreme HTML5 JavaScript Funnel Tooltips Top-Bottom Padding

shadow

Configures a tooltip's shadow.

Selector: DxShadow
Type:

Object

shared

Specifies whether the tooltip is shared across all series points with the same argument.

Type:

Boolean

Default Value: false

This property can have one of the following values:

tooltip.shared Description
false The tooltip only displays information about a series point that is hovered over with the mouse pointer.
true The tooltip displays information about all series points with the same argument as the point that is hovered over.
See Also

zIndex

Specifies a tooltip's z-index.

Selector: z-index
Type:

Number

| undefined
Default Value: undefined

If the UI component's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this property.