SVGGraph options: bar_total_callback

« Return to SVGGraph options page

Option name:
bar_total_callback
Default value:
NULL
Added in version:
2.19.1
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:
HorizontalStackedBarGraph PopulationPyramid StackedBarGraph StackedGroupedBarGraph
Tags:
stacked label bar callback

Callback function for bar total label text.

This option specifies a function that SVGGraph will call to format the text for the bar total labels. The option can be the name of a function, or an anonymous function itself. The default value NULL means no callback function is used and the label will contain the sum of the bars.

The function should have this signature:

function callback($key, $total)

The arguments to the function are the key for the stack and the total value. The function should return the text to display, or NULL to not display a label for the stack.

Here in an example using an anonymous function:

$settings['bar_total_callback'] = function($k, $t) {
  if($t < 1000)
    return NULL;
  return "Total:\n$t";
};

In this example totals smaller than 1000 will not be labelled. Values of 1000 and greater will be labelled with "Total:" and the total value on separate lines.

See also:
show_bar_totals data_label_callback

« Back to top of page Main SVGGraph page »