SVGGraph options: structured_data

« Return to SVGGraph options page

Option name:

structured_data

Default value:

false

Added in version:

2.11

Data type:

boolean [?]

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:

ArrayGraph Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CylinderGraph DonutGraph EmptyGraph 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:

global structure

Enables structured data values support.

This option enables parsing the values array as structured data - which means the values array must contain multiple item arrays, each containing a key value, one or more data values, and any amount of extra data.

The structured_data option by itself enables the default structure which is determined from the contents of the item arrays:

key - the first entry in the first item array is the key field
value - all other entries are dataset fields

As an example, here is some data in a structured format:

$values = array(
  array('Robert', 15, 10, 'cheese' => 4),
  array('Peter', 12, 9, 'cheese' => 6),
  array('Sarah', 18, 12, 'carrot' => 5),
);

and here is the default structure that SVGGraph will generate from it:

$structure = array(
  'key' => 0,
  'value' => array(1, 2, 'cheese', 'carrot')
);

The three data item arrays all start with default-indexed values, so these will be numbered 0, 1, 2. The last entry in each data item array is indexed using a string, either "cheese" or "carrot". SVGGraph's default structure assumes that everything apart from the first field is a data value, so it has found four datasets in this example.

For anything more complex you will have to use the structure option. Refer to the Structured data page for details.

The structure option being set to an array when the structured_data option is not set will automatically enable structured data. Explicitly setting the structured_data option to FALSE will make SVGGraph ignore the value of the structure option.

See also:: structure

« Back to top of page Main SVGGraph page »