|
|
|
|
|
|
|
|
- Tooltip options to configure
- Enabling/Disabling the tooltip
- Formatting the elements displayed in the tooltip
<Chart>.Tooltip (Function) In french: <Graphe>.Bulle Displays and formats: - the tooltip associated with each section of a chart (section of a Pie chart, column of 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.
CHART_MyChart.Label(grShowPercent, True)
CHART_MyChart.Tooltip(grTooltipFormat, -%"[%SERIES%]" + CR + -%"[%CATEGORY%]" + CR + -%"[%VALUE%]")
CHART_MyChart.Tooltip(grShowTooltip, True)
CHART_MyChart.Draw()
CHART_MyChart.Tooltip(1, 2, "The content of my tooltip")
CHART_MyChart.Draw()
Syntax
Displaying and formatting the tooltip associated with a Chart control Hide the details
<Chart control>.Tooltip(<Tooltip option to configure> , <Tooltip option value>)
<Chart control>: Control name Name of the Chart control to use (in the window editor).
<Tooltip option to configure>: Integer constant Enables or disables the tooltip and configures its characteristics. | | | grShowTooltip | Enables or disables the tooltip. | | grTooltipFormat | Defines the tooltip format. | | grTooltipFormatBubbleChart | Defines the tooltip format in a Bubble chart.
| | grTooltipFormatCrosshairHeader | Defines the format of the chart crosshair header. | | grTooltipFormatHeatMap | Defines the tooltip format in a Heatmap chart.
| | 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.
| | grTooltipFormatStock | Defines the tooltip format in a Stock chart.
|  New in version 2024grTooltipFormatWaffle | 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 control Hide the details
<Result> = <Chart control>.Tooltip(<Tooltip option>)
<Result>: Type corresponding to the option (boolean or character string) Value of the search option. <Chart control>: Control name Name of the Chart control to use (in the window editor).
<Tooltip option>: Integer constant Tooltip option whose value you want to get. | | | grShowTooltip | Enables or disables the tooltip. | | grTooltipFormat | Defines the tooltip format. | | grTooltipFormatBubbleChart | Defines the tooltip format in a Bubble chart.
| | grTooltipFormatCrosshairHeader | Defines the format of the chart crosshair header. | | grTooltipFormatHeatMap | Defines the tooltip format in a Heatmap chart.
| | 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.
| | grTooltipFormatStock | Defines the tooltip format in a Stock chart.
| New in version 2024grTooltipFormatWaffle | Defines the tooltip format in a Waffle 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 (in the window or page editor).
<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. | | grTooltipFormat | Defines the tooltip format. | Character string- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (defined by <Chart>.CategoryLabel).
[%VALUE%]: Displays the value
Example: "[%VALUE%]"+CR+"[%CATEGORY%]"
By default, the format is as follows: "[%CATEGORY%]"+CR+"[%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:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (defined by <Chart>.CategoryLabel).
[%MAX%]: Displays the highest value of the trading session.
[%MIN%]: Displays the lowest value of the trading session.
[%OPEN%]: Displays the opening value of the trading session.
[%CLOSE%]: Displays the closing value of the trading session.
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:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (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+"[%%%]" | | 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 by <Chart>.CategoryLabel).
By default, the format is as follows: "[%CATEGORY%]"
Stacked Column chart: You can add the total value of a stacked column to the tooltip of a Stacked Column chart by using the following syntax:
CHART_MyChart.grTooltip(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:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (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 | Defines the tooltip format in a Scatter chart. | Character string- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (defined by <Chart>.CategoryLabel).
[%X%]: Displays the X-coordinate.
By default, the format is as follows: "[%X%]"+CR+"[%Y%]"+CR+"[%SERIES%]"+CR+"[%CATEGORY%]" | | grTooltipFormatHeatMap | Defines the tooltip format in a Heatmap chart. | Character string- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (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 | Defines the tooltip format in a Pie chart. | Character string
- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by <Chart>.SeriesLabel).
[%CATEGORY%]: Displays the category label (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+"[%%%]" | New in version 2024grTooltipFormatWaffle | 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 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+"[%%%]" | | grTooltipFormatRangeArea | Defines the tooltip format in a Range Area chart. | Character string
- Empty string to use the default format.
- Combination of the following strings:
[%OPEN%]: Displays the opening value of the range.
[%CLOSE%]: Displays the closing value of the range.
[%CATEGORY%]: Displays the category label (defined by <Chart>.CategoryLabel).
Example: "[%OPEN%]"+CR+"[%CLOSE%]"+CR+"[%CATEGORY%]"
By default, the format is as follows: "[%OPEN%]"+CR+"[%CLOSE%] |
If the default format is used: Caution: If you use dynamic string construction ("Allow "[% %]" in strings" in the "Compilation" tab of the project description), a compilation error occurs (unknown identifier). In this case, each string must be preceded by '-%'. Example:
CHART_Deadline.Tooltip(grTooltipFormat, "[%CATEGORY%]" +CR +CR + "[%VALUE%]" + "H")
CHART_Deadline.Tooltip(grTooltipFormat, -%"[%CATEGORY%]" + CR + CR + -%"[%VALUE%]" + " H")
Enabling/Disabling the tooltip The tooltip activation/deactivation ( grShowTooltip constant) takes effect only when <Chart>.Draw is executed. Formatting the elements displayed in the tooltip To format the values displayed in the tooltip (value and percentage), use <Chart>.Mask.
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|