SVGGraph options: dataset_axis
- 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:
- BarAndLineGraph GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph MultiLineGraph MultiScatterGraph StackedBarAndLineGraph
Enables multiple Y-axes.
This option allows you to enable secondary Y axes on the right of the graph. The value of the option should be an array containing axis number values for each dataset, starting with axis 0 on the left and axes 1, 2, 3, etc. drawn on the right of the graph.
$settings['dataset_axis'] = array(0, 1, 0, 2);
This will plot dataset 0 against the left axis, dataset 1 against the first
right axis, dataset 2 against the left axis and dataset 3 against the second
right axis. If there are more datasets than this they will be plotted against
the left axis. Extra entries in the
dataset_axis array are ignored, so if
there are only two datasets in the data for the example above there will only
be one secondary axis drawn.
The axis on the left of the graph (axis
0) is always the primary axis that
the grid lines are drawn from - the
axis_right option is ignored where there
are multiple axes.
Each axis can be labelled and divided individually - see the relevant axis options for details and the multiple Y-axis graphs page for more examples.
Note: for StackedBarAndLineGraph only line datasets can be plotted against a secondary axis. This is so that the stacked bars will use the same scale.