<Chart>.Tooltip (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Chart management functions

Tooltip options to configure

Enabling/Disabling the tooltip

Formatting the elements displayed in the tooltip

See also

<Chart>.Tooltip (Function)

In french: <Graphe>.Bulle

Displays and formats:

the tooltip associated with each chart section (section for a Pie chart, bar for a Column chart, etc.). Also allows you to find out the characteristics of the tooltip associated with each chart section.
Versions 23 and later
a custom tooltip, associated with a point.
New in version 23
a custom tooltip, associated with a point.
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 site, 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.

Versions 19 and later

This function is now available for iPhone/iPad applications.

New in version 19

This function is now available for iPhone/iPad applications.

Versions 20 and later

This function is now available for the WEBDEV sites in Windows and Linux.

New in version 20

This function is now available for the WEBDEV sites in Windows and Linux.

Versions 23 and later

This function is now available for PHP sites.

This function is now available for Android applications.

New in version 23

This function is now available for PHP sites.

This function is now available for Android applications.

This function is now available for PHP sites.

This function is now available for Android applications.

Versions 25 and later

This function is now available in browser code.

New in version 25

This function is now available in browser code.

Example

// Chart control
// Display the percentages on a column chart
CHART_MyChart.Label(grShowPercent, True)
GRF_MonGraphe.Tooltip( grFormatBubble, -%"[%SERIE%]" + RC + -%"[%CATEGORIE%]" + RC + -%"[%VALEUR%]")
CHART_MyChart.Tooltip(grShowTooltip, True)
// Draw the chart
CHART_MyChart.Draw()

Versions 23 and later

// Chart control
// Display a specific tooltip for a point
CHART_MyChart.Tooltip(1, 2, "The content of my tooltip")
// Draw the chart
CHART_MyChart.Draw()

New in version 23

// Chart control
// Display a specific tooltip for a point
CHART_MyChart.Tooltip(1, 2, "The content of my tooltip")
// Draw the chart
CHART_MyChart.Draw()

Syntax

Displaying and formatting the tooltip associated with a Chart control Hide the details

<Chart control>.Tooltip(<Tooltip option to configure> , <Value of tooltip option>)

<Chart control>: Control name

Name of the Chart control to use (found in the window editor).
Only the interactive Chart controls are available.

<Tooltip option to configure>: Integer constant

Enables or disables the tooltip and configures its characteristics.
grShowTooltip Enables or disables the tooltip.
grTooltipFormat Describes the tooltip format.
grTooltipFormatStock Describes the tooltip format for a Stock chart.
This constant is not available.
Versions 20 and later
grTooltipFormatCrosshairHeader
New in version 20
grTooltipFormatCrosshairHeader
grTooltipFormatCrosshairHeader Describes the header format for the chart crosshairs.
Versions 16 and later
grTooltipFormatBubbleChart
New in version 16
grTooltipFormatBubbleChart
grTooltipFormatBubbleChart Describes the tooltip format for a Bubble chart.
This constant is not available.
Versions 21 and later
grTooltipFormatHeatMap
New in version 21
grTooltipFormatHeatMap
grTooltipFormatHeatMap Describes the tooltip format for a Heatmap chart.
This constant is not available.
grTooltipFormatScatter Describes the tooltip format for a Scatter chart.
This constant is not available.
grTooltipFormatPie Describes the tooltip format for a Pie chart.

<Value of tooltip option>: Character string or boolean

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

Finding out the characteristics of tooltip associated with a Chart control Hide the details

<Result> = <Chart control>.Tooltip(<Tooltip option>)

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

Value of sought option.

<Chart control>: Control name

Name of the Chart control to use (found in the window editor).
Only the interactive Chart controls are available.

<Tooltip option>: Integer constant

Tooltip option whose value is requested.
grShowTooltip Enables or disables the tooltip.
grTooltipFormat Describes the tooltip format.
grTooltipFormatStock Describes the tooltip format for a Stock chart.
This constant is not available.
Versions 20 and later
grTooltipFormatCrosshairHeader
New in version 20
grTooltipFormatCrosshairHeader
grTooltipFormatCrosshairHeader Describes the header format for the chart crosshairs.
Versions 16 and later
grTooltipFormatBubbleChart
New in version 16
grTooltipFormatBubbleChart
grTooltipFormatBubbleChart Describes the tooltip format for a Bubble chart.
This constant is not available.
Versions 21 and later
grTooltipFormatHeatMap
New in version 21
grTooltipFormatHeatMap
grTooltipFormatHeatMap Describes the tooltip format for a Heatmap chart.
This constant is not available.
grTooltipFormatScatter Describes the tooltip format for a Scatter chart.
This constant is not available.
grTooltipFormatPie Describes the tooltip format for a Pie chart.

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

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

<Chart control>: Control name

Name of the Chart control to use (found in the window editor or the page editor).
Only the 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 (with quotes)

Custom text of tooltip associated with the point.

Remarks

Tooltip options to configure

Constant	Effect	Value of option

grShowTooltip	Enables or disables the tooltip.	Boolean True (by default) to enable the tooltip, False to avoid displaying it. Caution: the parameters defined for the tooltip are not re-initialized during the display.
grTooltipFormat	Describes the tooltip format.	Character string Empty string to use the default format. Combination of following strings: [%SERIES%]: Displays the series caption (defined by <Chart>.SeriesLabel). [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). [%VALUE%]: Displays the value Example: "[%VALUE%]"+CR+"[%CATEGORY%]" By default, the format is as follows: "[%CATEGORY%]"+CR+"[%SERIES%]"+"="+"[%VALUE%]"
grTooltipFormatStock	Describes the tooltip format for a Stock chart.	Character string Empty string to use the default format. Combination of following strings: [%SERIES%]: Displays the series caption (defined by <Chart>.SeriesLabel). [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). [%MAX%]: Displays the maximum value of the session. [%MIN%]: Displays the minimum value of the session. [%START%]: Displays the first value of the session. [%END%]: Displays the end value of the session. By default, the format is as follows: "[%CATEGORY%]"+CR+"Min.=[%MIN%]"+CR+"Max.=[%MAX%]"+CR+"Start=[%START%]"+CR+"End=[%END%]"
Versions 20 and later grTooltipFormatCrosshairHeader New in version 20 grTooltipFormatCrosshairHeader grTooltipFormatCrosshairHeader	Describes the header format for the chart crosshairs.	Character string Empty string to use the default format. Character string containing the following string: [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). By default, the format is as follows: "[%CATEGORY%]" Versions 22 and later Stacked Column chart: The total of stack can be added into the tooltip of a stacked column chart by using the following syntax: CHART_MyChart.grTooltip(grTooltipFormatCrosshairHeader, ... "[%CATEGORY%], Sum = [%VALUE%]") New in version 22 Stacked Column chart: The total of stack can be added into the tooltip of a stacked column chart by using the following syntax: CHART_MyChart.grTooltip(grTooltipFormatCrosshairHeader, ... "[%CATEGORY%], Sum = [%VALUE%]") Stacked Column chart: The total of stack can be added into the tooltip of a stacked column chart by using the following syntax: CHART_MyChart.grTooltip(grTooltipFormatCrosshairHeader, ... "[%CATEGORY%], Sum = [%VALUE%]")
Versions 16 and later grTooltipFormatBubbleChart New in version 16 grTooltipFormatBubbleChart grTooltipFormatBubbleChart	Describes the tooltip format for a bubble chart.	Character string Empty string to use the default format. Combination of following strings: [%SERIES%]: Displays the series caption (defined by <Chart>.SeriesLabel). [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). [%X%]: Displays the X coordinate (first series) [%Y%]: Displays the Y coordinate (second series) [%Z%]: Displays the value of the third series. By default, the format is as follows: "([%X%];[%Y%]): [%Z%]"+CR+"[%CATEGORY%]"
grTooltipFormatScatter	Describes the tooltip format for a Scatter chart.	Character string Empty string to use the default format. Combination of following strings: [%SERIES%]: Displays the series caption (defined by <Chart>.SeriesLabel). [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). [%X%]: Displays the X coordinate. By default, the format is as follows: "[%X%]"+CR+"[%Y%]"+CR+"[%SERIES%]"+CR+"[%CATEGORY%]"
Versions 21 and later grTooltipFormatHeatMap New in version 21 grTooltipFormatHeatMap grTooltipFormatHeatMap	Describes the tooltip format for a Heatmap chart.	Character string Empty string to use the default format. Combination of following strings: [%SERIES%]: Displays the series caption (defined by <Chart>.SeriesLabel). [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). [%X%]: Displays the X coordinate (first series) [%Y%]: Displays the Y coordinate (second series) [%Z%]: Displays the value of the third series. By default, the format is as follows: "([%X%];[%Y%]): [%Z%]"+CR+"[%CATEGORY%]"
grTooltipFormatPie	Describes the tooltip format for a Pie chart.	Character string Empty string to use the default format. Combination of following strings: [%SERIES%]: Displays the series caption (defined by <Chart>.SeriesLabel). [%CATEGORY%]: Displays the category caption (defined by <Chart>.CategoryLabel). [%VALUE%]: Displays the value [%%%]: Displays the percentage Example: "[%VALUE%]"+CR+"[%CATEGORY%]"+CR+"[%%%]" By default, the format is as follows: "[%CATEGORY%]"+CR+"[%VALUE%]"+CR+"[%%%]"

If the default format is used:

"[%CATEGORY%]" is ignored if no category caption was specified by <Chart>.CategoryLabel.
the "[%SERIES%]" string is ignored if no series caption was specified with <Chart>.SeriesLabel.

Versions 22 and later
Caution: If you use the dynamic construction of chains (option "Allow "[%]" in chains" in the "Compilation" tab of the project's description), a compilation error appears (unknown identifier). In this case, each string must be preceded by '-%'. Example:

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

becomes

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

New in version 22
Caution: If you use the dynamic construction of chains (option "Allow "[%]" in chains" in the "Compilation" tab of the project's description), a compilation error appears (unknown identifier). In this case, each string must be preceded by '-%'. Example:

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

becomes

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

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

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

becomes

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

Enabling/Disabling the tooltip

The tooltip activation/deactivation (grShowTooltip constant) is taken into account when running <Chart>.Draw.

The tooltip activation/deactivation (grShowTooltip constant) is taken into account immediately.

Formatting the elements displayed in the tooltip

To format the values displayed in the tooltip (value and percentage), use <Chart>.Mask.

Component: wd260grf.dll