SVGGraph options: array_graph_options

« Return to previous page

Option name:

array_graph_options

Default value:

null

Added in version:

3.3

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: 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.
measurement: An integer or float value, or a string containing a number followed by one of these CSS units: px, in, cm, mm, pt, pc.
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:

Supported by:

ArrayGraph

Tags:

subgraph

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.

Example 1:

$settings = [
  'array_graph_options' => [
    'depth' => 10,
  ],
];

In example 1, the single array passes the same depth option to all subgraphs.

Example 2:

$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 depth of 30. The sequence is repeated for any further subgraphs, so the fourth graph would have a depth of 10.

Example 3:

$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.

See also:: array_graph_dataset array_graph_align array_graph_columns

« Back to top of page Main SVGGraph page »