SVGGraph options: array_graph_dataset
- Option name:
array_graph_dataset
- 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
orFALSE
value, or any values that convert easily such as1
,"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
orfloat
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
or1.63e5
orM_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
- Supported by:
- ArrayGraph
- Tags:
- See also:
- dataset array_graph_type array_graph_options
Assigns datasets to subgraphs of array graph.
By default, a subgraph is used for each of the enabled datasets. This option allows specific datasets to be assigned to each subgraph.
Example 1:
$settings = [
'array_graph_dataset' => [ 0, 2, 2, 3 ],
];
In example 1, assuming the datasets exist and are enabled, there will be four subgraphs displayed. The first will show dataset 0, the second and third will show dataset 2 and the fourth will show dataset 3. Dataset 1 is unused.
Example 2:
$settings = [
'array_graph_dataset' => [
[ 0, 1, 2],
3,
[ 2, 3 ],
],
];
In example 2, there will be three subgraphs displayed. The first will show
datasets 0, 1 and 2, the second will show dataset 3 and the third will show
datasets 2 and 3. Multiple datasets can only be shown on graph types that
support them, specified using the array_graph_type
option.