SVGGraph options: axis_text_callback_y

« Return to SVGGraph options 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.
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 [?]

Per-dataset options allow specifying one option for all datasets or an array of options to be used for each dataset in turn. If there are more datasets than entries in the option array, the sequence will be repeated.

Example:

$settings['widget_taste'] = 'banana';
$settings['widget_colour'] = array('red', 'green', 'blue');

For this example, the widgets for all datasets will taste of banana. The graph will use red widgets for dataset 0, green widgets for dataset 1 and blue widgets for dataset 2. Dataset 3 repeats the sequence so its widgets will be red, dataset 4 will have green widgets and dataset 5 will have blue widgets.

Supported by:
Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CylinderGraph FloatingBarGraph GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBarGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph PopulationPyramid RadarGraph ScatterGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph
Tags:
axis callback

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 dual 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

« Back to top of page Main SVGGraph page »