SVGGraph options: axis_text_callback_y

« Return to previous page

Option name:
axis_text_callback_y
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 TRUE or FALSE value, or any values that convert easily such as 1, "1", 0 and "".
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 integer or float value, 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 1 or -3.2 or 1.63e5 or M_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
Multi-axis:
yes [?]

Multi-axis options allow specifying one option for all axes on a multi-axis graph, or an array of options to be used for each axis in turn. If there are more axes than entries in the option array, the sequence will be repeated.

Example:

$settings['axis_taste'] = 'banana';
$settings['axis_smell'] = ['lavender', 'lemon', 'pine'];

For this example, all axes will taste of banana, but the leftmost axis will smell of lavender, the second axis will smell of lemon and the third axis will smell of pine. If there is a fourth axis it will smell of lavender, repeating the sequence.

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:
axis callback multi-axis text

Callback function for Y axis division text labels.

This option allows you to specify a function for formatting the text of the Y 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_y'] = function($v) {
  return sprintf('0x%04x', $v);
};

This will display the labels as 4 digits of hexadecimal with leading '0x'.

For vertical bar, line and scatter graphs the Y axis goes up the side of the graph. For horizontal bar graphs it is the horizontal axis along the bottom of the graph. For radar graphs the Y axis is the axis that comes out from the centre of the graph.

For multiple Y-axis graphs this option supports an array containing a function for each axis, for example:

$settings['axis_text_callback_y'] = array(NULL, function($v) {
  return $v >= 1000 ? ($v / 1000) . 'K' : $v;
});

The NULL in the array means that the left axis will use the standard number format. The callback function formats the right axis values >= 1000 as the value in thousands followed by a 'K' and lower values using the default number to string conversion.

See also:
axis_text_callback axis_text_callback_x dataset_axis

« Back to top of page Main SVGGraph page »

This site uses cookies - details here.