SVGGraph options: aspect_ratio

« Return to SVGGraph options page

Option name:
aspect_ratio
Default value:
1.0
Added in version:
1.1
Data type:
number [?]

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:
DonutGraph ExplodedPie3DGraph ExplodedPieGraph Pie3DGraph PieGraph PolarArea3DGraph PolarAreaGraph SemiDonutGraph
Tags:
pie padding

Ratio of pie graph height to width.

This option specifies the shape of the pie graph. The size of the graph is wholly determined by the size of the SVG document and the amount of padding around the edges. The default value 1.0 means the width and height will have an equal size and the pie will be circular. Values greater than 1 make the height greater than the width and values between 0 and 1 make the width greater than the height.

The option also supports the string value "auto" to make the pie graph fit into the whole area it has available in both directions.

Example:

$settings['aspect_ratio'] = 0.5;

The aspect ratio of 0.5 means the the height of the graph will be half its width. A value of 2.0 would reverse the shape so that the height would be twice the width. You can express the value as a fraction if you prefer, with the height over the width:

$settings['aspect_ratio'] = 2/3;

PHP will convert the expression into the floating-point value for 2/3, and the height of the resulting pie graph will be two-thirds of its width.

See also:
pad_left pad_top pad_right pad_bottom

« Back to top of page Main SVGGraph page »