grTooltip (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Chart functions

Tooltip options to configure
Enabling/Disabling the tooltip
Formatting the elements displayed in the tooltip
Customizable tooltip via an internal window

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

grTooltip (Function)

In french: grBulle

Displays and formats:

the tooltip associated with each portion of a graph (sector for a pie chart, bar for a column chart, etc.). This function also gets the characteristics of the tooltip associated with each section of the chart.
a custom tooltip, associated with a point.

By default, a tooltip is automatically displayed (grShowTooltip set to True) when a chart is hovered by the mouse cursor.

In a page of a WEBDEV website, the chart must be interactive in order for the tooltip to be displayed. To make the chart interactive, check "Interactive chart" in the "Details" tab of the control description.

Example

// Chart created programmatically
i is int
// Create the chart
grCreate("MyChart", grPie)
// Destination of the chart
grDestinationControl("MyChart", IMG_Image1)
// Display the percentages
grLabel("MyChart", grShowPercent, True)
// Add data
nValue is int
FOR i = 1 TO 200
	nValue = Random(30)
	grAddData("MyChart", 1, nValue)
	grCategoryLabel("MyChart", i, "Test" + i)
	grSeriesLabel("MyChart", 1, "Test series")
END
grTooltip("MyChart", grTooltipFormatPie, -%"[%SERIES%]" + CR + ...
	-%"[%CATEGORY%]" + CR + -%"[%%%]")
grTooltip("MyChart", grShowTooltip, True)
// Draw the chart
grDraw("MyChart")

// Chart control
// Display the percentages on a column chart
grLabel(CHART_MyChart, grShowPercent, True)
grTooltip(CHART_MyChart, grTooltipFormat, -%"[%SERIES%]" + CR + -%"[%CATEGORY%]" + ...
	CR + -%"[%VALUE%]")
grTooltip(CHART_MyChart, grShowTooltip, True)
// Draw chart in Chart control
grDraw(CHART_MyChart)

// Chart control
// Display a specific tooltip for a point
grTooltip(CHART_MyChart, 1, 2, "The tooltip content")
// Draw chart in Chart control
grDraw(CHART_MyChart)

Syntax

Displaying and formatting the tooltip associated with a chart Hide the details

grTooltip(<Chart name> , <Tooltip option to configure> , <Tooltip option value>)

<Chart name>: Control name or character string

Name of the chart to be used. This name corresponds to:
the name of the chart defined programmatically with grCreate.
the name of the Chart control in the window editor.
Only Chart controls are available.
Only interactive Chart controls are available.

<Tooltip option to configure>: Integer constant

Enables or disables the tooltip and configures its characteristics.
New in version 2025
grFormatBubbleInternalWindow
Name of the internal window used to display a custom bubble.
Constant not available.
grShowTooltip Enables or disables the tooltip.
grTooltipFormat Defines the tooltip format.
grTooltipFormatBubbleChart Defines the tooltip format in a Bubble chart.
This constant is not available.
grTooltipFormatCrosshairHeader Defines the format of the chart crosshair header.
grTooltipFormatHeatMap Defines the tooltip format in a Heatmap chart.
This constant is not available.
grTooltipFormatPie Defines the tooltip format in a Pie chart.
grTooltipFormatRangeArea Defines the tooltip format in a Range Area chart.
grTooltipFormatScatter Defines the tooltip format in a Scatter chart.
This constant is not available.
grTooltipFormatStock Defines the tooltip format in a Stock chart.
This constant is not available.
grTooltipFormatWaffle Defines the tooltip format in a Waffle chart.

<Tooltip option value>: Character string or boolean

Value of the selected tooltip option. This value depends on the selected option (see the above table).

Getting the characteristics of the tooltip associated with a chart Hide the details

<Result> = grTooltip(<Chart name> , <Tooltip option>)

<Result>: Type corresponding to the option (boolean or character string)

Value of the search option.

<Chart name>: Control name or character string

Name of the chart to be used. This name corresponds to:
the name of the chart defined programmatically with grCreate.
the name of the Chart control in the window editor.
Only Chart controls are available.
Only interactive Chart controls are available.

<Tooltip option>: Integer constant

Tooltip option whose value you want to get.
New in version 2025
grFormatBubbleInternalWindow
Name of the internal window used to display a custom bubble.
Constant not available.
grShowTooltip Enables or disables the tooltip.
grTooltipFormat Defines the tooltip format.
grTooltipFormatBubbleChart Defines the tooltip format in a Bubble chart.
This constant is not available.
grTooltipFormatCrosshairHeader Defines the format of the chart crosshair header.
grTooltipFormatHeatMap Defines the tooltip format in a Heatmap chart.
This constant is not available.
grTooltipFormatPie Defines the tooltip format in a Pie chart.
grTooltipFormatRangeArea Defines the tooltip format in a Range Area chart.
This constant is not available.
grTooltipFormatScatter Defines the tooltip format in a Scatter chart.
This constant is not available.
grTooltipFormatStock Defines the tooltip format in a Stock chart.
This constant is not available.
grTooltipFormatWaffle Defines the tooltip format in a Waffle chart.

Displaying and customizing the tooltip associated with a point Hide the details

grTooltip(<Chart name> , <Series number> , <Category number> , <Tooltip value>)

<Chart name>: Control name or character string

Name of the chart to be used. This name corresponds to:
the name of the chart defined programmatically with grCreate.
the name of the Chart control in the window or page editor.
Only Chart controls are available.
Only interactive Chart controls are available.

<Series number>: Integer

Number of the series to use.

<Category number>: Integer

Number of the category to use.

<Tooltip value>: Character string

Custom text of the tooltip associated with the point.

Remarks

Tooltip options to configure

Constant	Effect	Option value

grShowTooltip	Enables or disables the tooltip.	Boolean True (by default) to enable the tooltip, False to disable the tooltip. Caution: Tooltip parameters are not reset on display. The constant grBulleActive must be used to activate the bubble, regardless of the bubble's settings.
grTooltipFormat	Defines the tooltip format.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%VALUE%]: Displays the value Example: "[%VALUE%]"+CR+"[%CATEGORY%]" The default format is: "[%CATEGORY%]"+RC+"[%SERIES%]"+"="+"[%VALUE%]"
grTooltipFormatStock	Defines the tooltip format in a Stock chart.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%MAX%]: Displays the session's maximum value. [%MIN%]: Displays the session's minimum value. [%DEBUT%]: Displays the first value of the session. [%FIN%]: Displays the session end value. By default, the format is as follows: "[%CATEGORY%]"+CR+"Min.=[%MIN%]"+CR+"Max.=[%MAX%]"+CR+"Open=[%OPEN%]"+CR+"Close=[%CLOSE%]"
grTooltipFormatRadialBar	Defines the tooltip format in a Radial Bar chart.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%VALUE%]: Displays the value [%%%]: Displays the percentage Exemple: "[%VALEUR%]"+RC+"[%CATEGORIE%]"+RC+"[%%%]" The default format is "[%CATEGORY%]"+RC+"[%VALUE%]"+RC+"[%%%]"
grTooltipFormatCrosshairHeader	Defines the format of the chart crosshair header.	Character string Empty string to use the default format. Character string containing the following string: [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. The default format is "[%CATEGORY%]". Stacked histogram: You can add the stack total to the tooltip of a stacked histogram using the following syntax: `grTooltip(MySelf, grTooltipFormatCrosshairHeader, ... "[%CATEGORY%], Sum = [%VALUE%]")`
grTooltipFormatBubbleChart	Defines the tooltip format in a Bubble chart.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%X%]: Displays abscissa (first series) [%Y%]: Displays ordinate (second series) [%Z%]: Displays the value of the third series. The default format is "([%X%];[%Y%]): [%Z%]"+RC+"[%CATEGORY%]".
New in version 2025 grFormatBubbleInternalWindow	Displays the tooltip as an internal window	Character string corresponding to the name of the internal window (enclosed in quotation marks) used to customize the bubble associated with the chart. Internal window features: The bubble is displayed only. It is not possible to interact with internal window fields. Internal window prototype: PROCEDURE MyWindow(FieldGraph is Field, IndexSeries is an integer, Index is an integer, Value is a real, BallLabel is a string) Example: `grTooltip(GRF_Sales, grFormatInternalWindowTooltip, "FI_CustomTooltip")` Not available.
grTooltipFormatScatter	Defines the tooltip format in a Scatter chart.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%X%]: Displays abscissa. The default format is "[%X%]"+RC+"[%Y%]"+RC+"[%SERIE%]"+RC+"[%CATEGORIE%]".
grTooltipFormatHeatMap	Defines the tooltip format in a Heatmap chart.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%X%]: Displays abscissa (first series) [%Y%]: Displays ordinate (second series) [%Z%]: Displays the value of the third series. The default format is "([%X%];[%Y%]): [%Z%]"+RC+"[%CATEGORY%]".
grTooltipFormatPie	Defines the tooltip format in a Pie chart.	Character string Empty string to use the default format. Combination of the following strings: [%SERIE%]: Displays the series label (defined with the grSeriesLabel function).. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%VALUE%]: Displays the value [%%%]: Displays the percentage Exemple: "[%VALEUR%]"+RC+"[%CATEGORIE%]"+RC+"[%%%]" The default format is "[%CATEGORY%]"+RC+"[%VALUE%]"+RC+"[%%%]"
grTooltipFormatWaffle	Defines the tooltip format in a Waffle chart.	Character string Empty string to use the default format. Combination of the following strings: [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. [%VALUE%]: Displays the value [%%%]: Displays the percentage Example: "[%VALUE%]"+CR+"[%CATEGORY%]"+CR+"[%%%]" The default format is "[%CATEGORY%]"+RC+"[%VALUE%]"+RC+"[%%%]"
grTooltipFormatRangeArea	Defines the tooltip format in a Range Area chart.	Character string Empty string to use the default format. Combination of the following strings: [%DEBUT%]: Displays interval start value. [%FIN%]: Displays end of interval value. [%CATEGORY%]: Displays the category label (defined with the grCategoryLabel function).. Example: "[%OPEN%]"+CR+"[%CLOSE%]"+CR+"[%CATEGORY%]" The default format is: "[%DEBUT%]"+RC+"[%FIN%]

If the default format is used:

"[%CATEGORY%]" is ignored if no category label was specified by grCategoryLabel.
"[%SERIES%]" is ignored if no series label was specified with grSeriesLabel.

Warning: A compilation error may occur If you use dynamic string construction (option "Allow "[% %]" in strings" in the "Compilation" tab of the project description), a compilation error may appear (unknown identifier). In this case, each string must be preceded by '-%'. Example:

grTooltip(CHART_Deadline, grTooltipFormat, "[%CATEGORY%]" + CR + CR+ "[%VALUE%]" + " H")

becomes

grTooltip(CHART_Deadline, grTooltipFormat, -%"[%CATEGORY%]" + CR + CR + -%"[%VALUE%]" + " H")

Enabling/Disabling the tooltip

The tooltip activation/deactivation (grShowTooltip constant) takes effect only when grDraw is executed.

The activation/deactivation of the tooltip (grShowTooltip constant) takes effect immediately.

Formatting the elements displayed in the tooltip

To format the values displayed in the tooltip (value and percentage), use grMask.

New in version 2025

Customizable tooltip via an internal window

The function grTooltip used with the constant grFormatBubbleInternalWindow is used to specify the internal window used to display the tooltip for a Chart control.

This internal window is for display only. No interaction between user and bubble possible.

This internal window uses the following prototype:

PROCEDURE MyWindow(FieldGraph is Field,
IndexSeries is an integer, IndexValue is an integer, Value is a real, LabelBubble is a string)

where:

ChartControl: Name of the Chart control used.
SeriesIndex: Index of the series corresponding to the point hovered over.
Index: Index of the point value overflown.
Value: Value of the point hovered over.
BubbleLabel: Label of the bubble normally displayed. This label can be formatted using the function grTooltip used with the constant grFormatBulle.

Internal window features:

Fields in the internal window cannot be manipulated by the user.
The opacity defined for fields in the internal window is taken into account.
The size of the internal window used for the tooltip automatically adapts to the content when displayed.

Special cases:

In the case of a multi-series crosshairs, the series index and value correspond to the point closest to the mouse. In this case, the "Index" parameter is identical for all points.
For stock charts, bubble charts, heatmaps and range area charts, a single value is returned.
In the internal window code, it is possible to retrieve data from other series using the grGetData function. For example:
```
// Retrieve previous value
grGetData(FieldGraph, NumSeries, Index-1)
```

It is also possible to retrieve information such as the legend or color of the series using the properties available in the Chart control.

Related Examples:

Training (WINDEV): WD Chart

[ + ] This example presents the different uses of the Chart control.
Different types of charts are presented:
- Pie
- Sunburst
- Line
- Scatter
- Column
- Area
- etc.

The main features presented here are the possibility to customize of charts from the code, as well as to fill the chart from an HFSQL data file, or in the editor.

Business / UI classification: UI Code

Component: wd300grf.dll