PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

This content has been translated automatically. Click here to view the French version.
  • Tooltip options to configure
  • Enabling/Disabling the tooltip
  • Formatting the elements displayed in the tooltip
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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.
WEBDEV - Server codeWEBDEV - Browser code 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
iPhone/iPad This function is now available for iPhone/iPad applications.
New in version 19
iPhone/iPad This function is now available for iPhone/iPad applications.
iPhone/iPad This function is now available for iPhone/iPad applications.
Versions 20 and later
WEBDEV - Server codeWindowsLinux This function is now available for the WEBDEV sites in Windows and Linux.
New in version 20
WEBDEV - Server codeWindowsLinux This function is now available for the WEBDEV sites in Windows and Linux.
WEBDEV - Server codeWindowsLinux This function is now available for the WEBDEV sites in Windows and Linux.
Versions 23 and later
PHP This function is now available for PHP sites.
Android This function is now available for Android applications.
New in version 23
PHP This function is now available for PHP sites.
Android This function is now available for Android applications.
PHP This function is now available for PHP sites.
Android This function is now available for Android applications.
Versions 25 and later
WEBDEV - Browser code This function is now available in browser code.
New in version 25
WEBDEV - Browser code This function is now available in browser code.
WEBDEV - Browser code This function is now available in browser code.
Example
WindowsLinuxiPhone/iPad
// Graphe créé par programmation
i is int
// Création du graphe
grCreate("MonGraphe", grPie)
// Destination du graphe
grDestinationControl("MonGraphe", IMG_Image1)
// Affichage des pourcentages
grLabel("MonGraphe", grShowPercent, True)
// Ajout des données
nValeur is int
FOR i = 1 TO 20
nValeur = Random(30)
grAddData("MonGraphe", 1, nValeur)
grCategoryLabel("MonGraphe", i, "Test" + i)
grSeriesLabel("MonGraphe", 1," Série de test")
END
grTooltip("MonGraphe", grTooltipFormatPie, -%"[%SERIE%]" + CR + ...
-%"[%CATEGORIE%]" + CR + -%"[%%%]")
grTooltip("MonGraphe", grShowTooltip, True)
// Dessin du graphe
grDraw("MonGraphe")
// Champ Graphe
// Affichage des pourcentages sur un histogramme
grLabel(GRF_MonGraphe, grShowPercent, True)
grTooltip(GRF_MonGraphe, grTooltipFormat, -%"[%SERIE%]" + CR + -%"[%CATEGORIE%]" + ...
CR + -%"[%VALEUR%]")
grTooltip(GRF_MonGraphe, grShowTooltip, True)
// Dessin du graphe
grDraw(GRF_MonGraphe)
Versions 23 and later
// Champ Graphe
// Affichage d'une bulle spécifique pour un point
grTooltip(GRF_MonGraphe, 1, 2, "Le contenu de ma bulle d'aide")
// Dessin du graphe
grDraw(GRF_MonGraphe)
New in version 23
// Champ Graphe
// Affichage d'une bulle spécifique pour un point
grTooltip(GRF_MonGraphe, 1, 2, "Le contenu de ma bulle d'aide")
// Dessin du graphe
grDraw(GRF_MonGraphe)
// Champ Graphe
// Affichage d'une bulle spécifique pour un point
grTooltip(GRF_MonGraphe, 1, 2, "Le contenu de ma bulle d'aide")
// Dessin du graphe
grDraw(GRF_MonGraphe)
Syntax

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

grTooltip(<Chart name> , <Tooltip option to configure> , <Value of tooltip option>)
<Chart name>: Control name or character string
Name of the chart to be used. This name corresponds to:
  • the chart name defined through programming with grCreate.
  • the name of Chart control found in the window editor.
Android Only Chart controls are available.
WEBDEV - Browser codePHP Only the interactive Chart controls are available.
<Tooltip option to configure>: Integer constant
Enables or disables the tooltip and configures its characteristics.
grShowTooltipEnables or disables the tooltip.
grTooltipFormatDescribes the tooltip format.
grTooltipFormatStockDescribes the tooltip format for a Stock chart.
Android 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.
Android This constant is not available.
Versions 21 and later
grTooltipFormatHeatMap
New in version 21
grTooltipFormatHeatMap
grTooltipFormatHeatMap
Describes the tooltip format for a Heatmap chart.
Android This constant is not available.
grTooltipFormatScatterDescribes the tooltip format for a Scatter chart.
Android This constant is not available.
grTooltipFormatPieDescribes the tooltip format for a Pie chart.
Versions 26 and later
grTooltipFormatRangeArea
New in version 26
grTooltipFormatRangeArea
grTooltipFormatRangeArea
Describes the tooltip format for an interval Zone graph.
<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 Hide the details

<Result> = grTooltip(<Chart name> , <Tooltip option>)
<Result>: Type corresponding to the option (boolean or character string)
Value of sought option.
<Chart name>: Control name or character string
Name of the chart to be used. This name corresponds to:
  • the chart name defined through programming with grCreate.
  • the name of Chart control found in the window editor.
Android Only Chart controls are available.
WEBDEV - Browser codePHP Only the interactive Chart controls are available.
<Tooltip option>: Integer constant
Tooltip option whose value is requested.
grShowTooltipEnables or disables the tooltip.
grTooltipFormatDescribes the tooltip format.
grTooltipFormatStockDescribes the tooltip format for a Stock chart.
Android 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.
Android This constant is not available.
Versions 21 and later
grTooltipFormatHeatMap
New in version 21
grTooltipFormatHeatMap
grTooltipFormatHeatMap
Describes the tooltip format for a Heatmap chart.
Android This constant is not available.
grTooltipFormatScatterDescribes the tooltip format for a Scatter chart.
Android This constant is not available.
grTooltipFormatPieDescribes the tooltip format for a Pie chart.
Versions 26 and later
grTooltipFormatRangeArea
New in version 26
grTooltipFormatRangeArea
grTooltipFormatRangeArea
Describes the tooltip format for an interval Zone graph.
Android This constant is not available.
Versions 23 and later

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 chart name defined through programming with grCreate.
  • the name of Chart control found in the window editor or page editor.
Android Only Chart controls are available.
WEBDEV - Browser codePHP 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
Custom text of tooltip associated with the point.
New in version 23

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 chart name defined through programming with grCreate.
  • the name of Chart control found in the window editor or page editor.
Android Only Chart controls are available.
WEBDEV - Browser codePHP 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
Custom text of tooltip associated with the point.

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 chart name defined through programming with grCreate.
  • the name of Chart control found in the window editor or page editor.
Android Only Chart controls are available.
WEBDEV - Browser codePHP 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
Custom text of tooltip associated with the point.
Remarks

Tooltip options to configure

ConstantEffectValue of option
grShowTooltipEnables 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.
grTooltipFormatDescribes the tooltip format.Character string
  • Empty string to use the default format.
  • Combination of following strings:
    [%SERIES%]: Displays the series label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%VALUE%]: Displays the value
    Example: "[%VALUE%]"+RC+"[%CATEGORY%]"
By default, the format is as follows: "[%CATEGORY%]"+CR+"[%SERIES%]"+"="+"[%VALUE%]"
grTooltipFormatStockDescribes the tooltip format for a Stock chart.Character string
  • Empty string to use the default format.
  • Combination of following strings:
    [%SERIES%]: Displays the series label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%MAX%]: Displays the maximum value of the session.
    [%MIN%]: Displays the minimum value of the session.
    [%DEBUT%]: Displays the first value of the session.
    [%FIN%]: 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 27 and later
grTooltipFormatRadialBar
New in version 27
grTooltipFormatRadialBar
grTooltipFormatRadialBar
Describes the tooltip format for a progress circle graph.Character string
  • Empty string to use the default format.
  • Combination of following strings:
    [%SERIES%]: Displays the series label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%VALUE%]: Displays the value
    [%%%]: Displays the percentage
    Example: "[%VALUE%]"+CR+"[%CATEGORY%]"+CR+"[%%%]"
By default, the format is as follows: "[%CATEGORY%]"+CR+"[%VALUE%]"+CR+"[%%%]"
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 label (defined with function grCategoryLabel).
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:
grTooltip(MySelf, grTooltipFormatCrosshairHeader, ...
"[%CATEGORIE%], Somme = [%VALEUR%]")
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:
grTooltip(MySelf, grTooltipFormatCrosshairHeader, ...
"[%CATEGORIE%], Somme = [%VALEUR%]")
Stacked Column chart: The total of stack can be added into the tooltip of a stacked column chart by using the following syntax:
grTooltip(MySelf, grTooltipFormatCrosshairHeader, ...
"[%CATEGORIE%], Somme = [%VALEUR%]")
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 label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%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%]"+RC+"[%CATEGORY%]"
grTooltipFormatScatterDescribes the tooltip format for a Scatter chart.Character string
  • Empty string to use the default format.
  • Combination of following strings:
    [%SERIES%]: Displays the series label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%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 label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%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%]"+RC+"[%CATEGORY%]"
grTooltipFormatPieDescribes the tooltip format for a Pie chart.Character string
  • Empty string to use the default format.
  • Combination of following strings:
    [%SERIES%]: Displays the series label (defined with function grSeriesLabel).
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    [%VALUE%]: Displays the value
    [%%%]: Displays the percentage
    Example: "[%VALUE%]"+CR+"[%CATEGORY%]"+CR+"[%%%]"
By default, the format is as follows: "[%CATEGORY%]"+CR+"[%VALUE%]"+CR+"[%%%]"
Versions 26 and later
grTooltipFormatRangeArea
New in version 26
grTooltipFormatRangeArea
grTooltipFormatRangeArea
Describes the tooltip format for an interval Zone graph.Character string
  • Empty string to use the default format.
  • Combination of following strings:
    [%DEBUT%]: Displays the start value of interval.
    [%FIN%]: Displays the end value of the interval.
    [%CATEGORY%]: Displays the category label (defined with function grCategoryLabel).
    Example: "[%DEBUT%]"+RC+"[%FIN%]"+RC+"[%CATEGORY%]"
By default, the format is as follows: "[%DEBUT%]"+RC+"[%FIN%]

If the default format is used:
  • the string "[%CATEGORY%]" is ignored if no category label has been specified with the grCategoryLabel function.
  • the string "[%SERIE%]" is ignored if no series label has been specified with the grSeriesLabel function.
Versions 22 and later
Caution: If you use dynamic string construction (option "Allow "[% %]" in strings" in the "Compilation" tab of the description project), a compilation error appears (unknown identifier). In this case, each string must be preceded by '-%'. Example:
grTooltip(GRF_Echéance, grTooltipFormat, "[%CATEGORIE%]" + CR + CR+ "[%VALEUR%]" + " H")
becomes
grTooltip(GRF_Echéance, grTooltipFormat, -%"[%CATEGORIE%]" + CR + CR + -%"[%VALEUR%]" + " H")
New in version 22
Caution: If you use dynamic string construction (option "Allow "[% %]" in strings" in the "Compilation" tab of the description project), a compilation error appears (unknown identifier). In this case, each string must be preceded by '-%'. Example:
grTooltip(GRF_Echéance, grTooltipFormat, "[%CATEGORIE%]" + CR + CR+ "[%VALEUR%]" + " H")
becomes
grTooltip(GRF_Echéance, grTooltipFormat, -%"[%CATEGORIE%]" + CR + CR + -%"[%VALEUR%]" + " H")
Caution: If you use dynamic string construction (option "Allow "[% %]" in strings" in the "Compilation" tab of the description project), a compilation error appears (unknown identifier). In this case, each string must be preceded by '-%'. Example:
grTooltip(GRF_Echéance, grTooltipFormat, "[%CATEGORIE%]" + CR + CR+ "[%VALEUR%]" + " H")
becomes
grTooltip(GRF_Echéance, grTooltipFormat, -%"[%CATEGORIE%]" + CR + CR + -%"[%VALEUR%]" + " H")

Enabling/Disabling the tooltip

The activation/deactivation of the tooltip (constant grShowTooltip) is only taken into account when the grDraw function is executed.
WEBDEV - Browser code 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 grMask.
Business / UI classification: UI Code
Component: wd270grf.dll
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment