SVGGraph options: context_callback

« Return to SVGGraph options page

Option name:
context_callback
Default value:
null
Added in version:
2.29
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 DonutGraph ExplodedPie3DGraph ExplodedPieGraph FloatingBarGraph GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph Histogram HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBarGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph Pie3DGraph PieGraph PolarArea3DGraph PolarAreaGraph PopulationPyramid RadarGraph ScatterGraph SemiDonutGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph
Tags:
context-menu javascript callback global

Callback function for context menu.

This option specifies a callback function for assigning the contents of the context menu for each item of data. The default value null means that a callback is not used - a global menu can be set using context_global or alternatively per-item context menus can be set using the structured data context_menu field.

The format of a context menu is an array containing an array for each line in the menu, with each line consisting of a title and link location, as in this example:

$settings['context_global'] = array(
  array('Title', null),
  array('Link 1', '/link-target-1/'),
  array('Link 2', '/link-target-2/'),
  array('Link 3', 'http://link-target-3/'),
);

The first line in the menu has a null link address, so it will be presented as plain text.

The context menu callback function is similar to the tooltip and data label callback functions, and is called with three arguments: the dataset, key and value:

$settings['context_callback'] = function($dataset, $key, $value) {
  if($dataset != 1)
    return null;
  $menu = array(
    array("Context menu", null),
    array("About $key", "/link/$key/"),
    array("More about $key", "/link/$key/more/"),
  );
  return $menu;
};

This example callback returns null if the data item is not in dataset 1, so these data items will not have their own menu. The dataset 1 items will have a menu containing three items: a title and two links.

See also:
show_context_menu context_global structure

« Back to top of page Main SVGGraph page »