BuyLog In
DevExtreme
All docs
V 24.1
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
18.1
17.2
All docs
V24.1

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
18.1
17.2
Full-text search
Overview
Getting Started
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DateRangeBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
FileUploader
FilterBuilder
Floating Action Button
Form
Funnel
Gallery
Gantt
HtmlEditor
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NumberBox
PieChart
Getting Started
How To
API
Configuration
adaptiveLayout
animation
annotations[]
centerTemplate
commonAnnotationSettings
commonSeriesSettings
customizeAnnotation
customizeLabel
customizePoint
dataSource
diameter
disabled
elementAttr
export
innerRadius
legend
loadingIndicator
margin
minDiameter
onDisposing
onDone
onDrawn
onExported
onExporting
onFileSaving
onIncidentOccurred
onInitialized
onLegendClick
onOptionChanged
onPointClick
onPointHoverChanged
onPointSelectionChanged
onTooltipHidden
onTooltipShown
palette
paletteExtensionMode
pathModified
pointSelectionMode
redrawOnResize
resolveLabelOverlapping
rtlEnabled
segmentsDirection
series
seriesTemplate
size
sizeGroup
startAngle
theme
title
tooltip
argumentFormat
arrowLength
border
color
container
contentTemplate
cornerRadius
customizeTooltip
enabled
font
format
interactive
opacity
paddingLeftRight
paddingTopBottom
shadow
shared
zIndex
type
Methods
Events
Series Types
Chart Elements
Interfaces
Types
Demos
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Scheduler
ScrollView
SelectBox
Slider
Sortable
Sparkline
Splitter
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
VectorMap
Common Types
Utilities
Data Binding
Data Validation
TypeScript Guides
Localization and Globalization
UI Customization
Integration Guides
DevExtreme CLI
Data Analytics and BI
.NET Backend Solutions
Advanced Topics
Troubleshooting
Migrate to the New Version

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery PieChart - tooltip

Configures tooltips.

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.

Type:

Format

Default Value: undefined

NOTE
DevExtreme UI components 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 topics in the Installation section.
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.

Type:

Number

Default Value: 10

border

Configures a tooltip's border.

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

Default Value: undefined

contentTemplate

Specifies a custom template for a tooltip.

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.

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.

Type:

Function

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.

Type:

Object

format

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

Type:

Format

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

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.

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.

Type:

Number

Default Value: 15

DevExtreme HTML5 JavaScript Funnel Tooltips Top-Bottom Padding

shadow

Configures a tooltip's shadow.

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.

Type:

Number

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.