SVGGraph options: array_graph_options
- Option name:
- Default value:
- Added in version:
- Data type:
- array [?]
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(), the number and data types of its members will depend on the option for which is it used.
- A boolean
FALSEvalue, or any values that convert easily such as
- A callable function, which can be either the name of a function or an anonymous function itself.
- 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.
- A colour value or one of the gradients and patterns supported by SVGGraph. See the SVGGraph colours page for details.
- A negative or positive whole number or
- Any number supported by PHP, for example
- Single or double quoted strings. Remember to double-quote your strings
if you are inserting a line break:
"Line 1\nLine 2".
- 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.
$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:
Options to be passed to subgraphs of array graph.
By default, all options from the parent graph are passed through to the array of subgraphs. The value of this option could be a single array of options to be passed to all array subgraphs, or an array of option arrays to be passed individually to the subgraphs.
$settings = [ 'array_graph_options' => [ 'depth' => 10, ], ];
In example 1, the single array passes the same
depth option to all subgraphs.
$settings = [ 'array_graph_options' => [ [ 'depth' => 10, ], [ 'depth' => 20, ], [ 'depth' => 30, ], ], ];
In example 2, the first graph in the array receives the
depth value of 10,
the second graph receives a
depth of 20 and the third graph receives a
of 30. The sequence is repeated for any further subgraphs, so the fourth graph
would have a
depth of 10.
$settings = [ 'depth' => 40, 'array_graph_options' => [ [ 'depth' => 10, ], [ 'reverse' => true, ], ], ];
In example 3, the first graph receives a
depth value of 10 again but no
value is specifed for the
depth in the array for the second subgraph. This
means the second subgraph will inherit the
depth option from the main
options array, which has a value of 40.