SVGGraph options: bar_total_callback

« Return to SVGGraph options page

Option name:
Default value:
Added in version:
Data type:
callback [?]


A negative or positive whole number or 0.
no [?]



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


Supported by:
HorizontalStackedBarGraph PopulationPyramid StackedBarGraph StackedGroupedBarGraph
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 »