|
|
|
|
- Tooltip options to configure
- Enabling/Disabling the tooltip
- Formatting the elements displayed in the tooltip
grTooltip (Function) In french: grBulle 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.
- 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 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 the chart grDraw(CHART_MyChart)
// Chart control // Display a specific tooltip for a point grTooltip(CHART_MyChart, 1, 2, "The tooltip content") // Draw the chart 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 chart name defined through programming with grCreate.
- the name of the Chart control 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 | Describes the tooltip format. | grTooltipFormatBubbleChart | Describes the tooltip format for a Bubble chart.
| grTooltipFormatCrosshairHeader | Describes the header format for the chart crosshairs. | grTooltipFormatHeatMap | Describes the tooltip format for a Heatmap chart.
| grTooltipFormatPie | Describes the tooltip format for a Pie chart. | grTooltipFormatRangeArea | Describes the tooltip format for a Range Area chart. | grTooltipFormatScatter | Describes the tooltip format for a Scatter chart.
| grTooltipFormatStock | Describes the tooltip format for a Stock chart.
|
<Tooltip option value>: Character string or boolean Option value 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 the 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 the Chart control in the window editor.
<Tooltip option>: Integer constant Tooltip option whose value is requested. | | grShowTooltip | Enables or disables the tooltip. | grTooltipFormat | Describes the tooltip format. | grTooltipFormatBubbleChart | Describes the tooltip format for a Bubble chart.
| grTooltipFormatCrosshairHeader | Describes the header format for the chart crosshairs. | grTooltipFormatHeatMap | Describes the tooltip format for a Heatmap chart.
| grTooltipFormatPie | Describes the tooltip format for a Pie chart. | grTooltipFormatRangeArea | Describes the tooltip format for a Range Area chart.
| grTooltipFormatScatter | Describes the tooltip format for a Scatter chart.
| grTooltipFormatStock | Describes the tooltip format for a Stock 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 chart name defined through programming with grCreate.
- the name of the Chart control 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 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 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 the following strings:
[%SERIES%]: Displays the series label (defined by grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by grCategoryLabel). [%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 the following strings:
[%SERIES%]: Displays the series label (defined by grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by grCategoryLabel). [%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%]" | grTooltipFormatRadialBar | Describes the tooltip format for 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 grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by grCategoryLabel). [%VALUE%]: Displays the value [%%%]: Displays the percentage Example: "[%VALUE%]"+CR+"[%CATEGORY%]"+CR+"[%%%]" By default, the format is as follows: "[%CATEGORY%]"+CR+"[%VALUE%]"+CR+"[%%%]" | 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 by grCategoryLabel). By default, the format is as follows: "[%CATEGORY%]"
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, ... "[%CATEGORY%], Sum = [%VALUE%]")
| grTooltipFormatBubbleChart | Describes the tooltip format for a bubble chart. | Character string- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by 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%]"+CR+"[%CATEGORY%]" | grTooltipFormatScatter | Describes the tooltip format for a Scatter chart. | Character string- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by grCategoryLabel). [%X%]: Displays the X-coordinate. By default, the format is as follows: "[%X%]"+CR+"[%Y%]"+CR+"[%SERIES%]"+CR+"[%CATEGORY%]" | grTooltipFormatHeatMap | Describes the tooltip format for a Heatmap chart. | Character string- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by 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%]"+CR+"[%CATEGORY%]" | grTooltipFormatPie | Describes the tooltip format for a Pie chart. | Character string
- Empty string to use the default format.
- Combination of the following strings:
[%SERIES%]: Displays the series label (defined by grSeriesLabel). [%CATEGORY%]: Displays the category label (defined by grCategoryLabel). [%VALUE%]: Displays the value [%%%]: Displays the percentage Example: "[%VALUE%]"+CR+"[%CATEGORY%]"+CR+"[%%%]" By default, the format is as follows: "[%CATEGORY%]"+CR+"[%VALUE%]"+CR+"[%%%]" | grTooltipFormatRangeArea | Describes the tooltip format for a Range Area chart. | Character string
- Empty string to use the default format.
- Combination of the following strings:
[%START%]: Displays the start value of the interval. [%END%]: Displays the end value of the interval. [%CATEGORY%]: Displays the category label (defined by grCategoryLabel). Example: "[%START%]"+CR+"[%END%]"+CR+"[%CATEGORY%]" By default, the format is as follows: "[%START%]"+CR+"[%END%] |
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.
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:
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) is taken into account when running grDraw. 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
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|