SVGGraph options: tooltip_callback
- Option name:
tooltip_callback- Default value:
NULL- Added in version:
- 2.19
- Data type:
- callback [?]
The datatypes used in this documentation for specifying SVGGraph options are described below. All options can be a literal value of the data type described, a variable containing the data type, or an expression that will produce the data type when evaluated (and they must always be valid PHP expressions).
- array
- An
array, the number and data types of its members will depend on the option for which is it used. - boolean
- A boolean
TRUEorFALSEvalue, or any values that convert easily such as1,"1",0and"". - callback
- A callable function, which can be either the name of a function or an anonymous function itself.
- colour
- Any of the colour values supported by SVG inside a single or double
quoted string. These include three and six digit hex codes, RGB and
RGBA colours, and colour names. SVG uses
"none"for no colour, which generally leaves things transparent. - fill
- A colour value or one of the gradients and patterns supported by SVGGraph. See the SVGGraph colours page for details.
- integer
- A negative or positive whole number or
0. - measurement
- An
integerorfloatvalue, or a string containing a number followed by one of these CSS units:px,in,cm,mm,pt,pc. - number
- Any number supported by PHP, for example
1or-3.2or1.63e5orM_PI. - string
- Single or double quoted strings. Remember to double-quote your strings
if you are inserting a line break:
"Line 1\nLine 2".
- Per-dataset:
- no
- Supported by:
- ArrayGraph Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CandlestickGraph CylinderGraph Donut3DGraph DonutGraph EmptyGraph ExplodedDonut3DGraph ExplodedDonutGraph ExplodedPie3DGraph ExplodedPieGraph ExplodedSemiDonut3DGraph ExplodedSemiDonutGraph FloatingBarGraph GanttChart GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph Histogram HorizontalBar3DGraph HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBar3DGraph HorizontalGroupedBarGraph HorizontalStackedBar3DGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph MultiSteppedLineGraph Pie3DGraph PieGraph PolarArea3DGraph PolarAreaGraph PopulationPyramid RadarGraph ScatterGraph SemiDonut3DGraph SemiDonutGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph SteppedLineGraph
- Tags:
- See also:
- show_tooltips
Callback function for formatting tooltip text.
This option should be the name of the function to use, or the (anonymous) function itself:
$settings['tooltip_callback'] = 'TooltipText';
In the example above, TooltipText must be defined somewhere in your PHP code.
$settings['tooltip_callback'] = function($d, $k, $v) {
return "$d - $k - $v";
};
This example uses an anonymous function instead.
The function will be called with three arguments:
$tooltip_text = callback($dataset, $key, $value);
The function should return a text string to display or NULL to not show a
tooltip for the current item.
The callback function takes precedence over any structured data tooltip values.