SVGGraph options: axis_text_callback
- Option name:
axis_text_callback- Default value:
NULL- Added in version:
- 2.18
- 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:
- Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CandlestickGraph CylinderGraph FloatingBarGraph GanttChart GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph HorizontalBar3DGraph HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBar3DGraph HorizontalGroupedBarGraph HorizontalStackedBar3DGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph MultiSteppedLineGraph PopulationPyramid RadarGraph ScatterGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph SteppedLineGraph
- Tags:
- See also:
- axis_text_callback_x axis_text_callback_y
Callback function for axis division text labels.
This option allows you to specify a function for formatting the text of the axis division labels. This should be either a string containing the name of the function to use or an anonymous function.
The function should have this signature:
function callback($value);
The function will be passed one value corresponding to its position on the axis and it should return the string to display. Here is an example using an anonymous function:
$settings['axis_text_callback'] = function($v) {
return "[{$v}]";
};
This will display the labels wrapped inside square brackets.
Note: for associative arrays the value passed to the function for the X axis labels is the numeric position of the data item and not its array key. The callback function is actually passed a second, optional value containing the associative array key:
function callback($array_index, $key);
For the Y-axis the callback function is called with the same value in both arguments.
To set a callback for each axis separately, use the axis_text_callback_x and
axis_text_callback_y options.