SVGGraph options: line_figure

« Return to previous page

Option name:

line_figure

Default value:

false

Added in version:

2.27

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.

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:

no

Supported by:

LineGraph MultiLineGraph MultiRadarGraph RadarGraph

Tags:

line radar

Enables drawing shapes using line graphs.

Enabling this option changes the way that the line graphs behave in a few ways. Firstly, repeated key values will be accepted, allowing for vertical lines. Secondly, key values will not be sorted, allowing for lines to be drawn from right to left. Finally, the fill_under option fills the shape formed by the line instead of filling from the line to the X-axis.

The line_figure_closed option may be used to close the shape path, joining the first and last points.

To draw multiple shapes you must use the MultiLineGraph or MultiRadarGraph classes, with each shape in its own dataset.

Example:

$settings = array(
  'line_figure' => true,
  'fill_under' => true,
  'structure' => array('key' => 0, 'value' => array('box', 'triangle')),
);

$values = array(
  array(10, 'box' => 10),
  array(30, 'box' => 10),
  array(30, 'box' => 40),
  array(10, 'box' => 40),
  array(20, 'triangle' => 25),
  array(50, 'triangle' => 10),
  array(50, 'triangle' => 40),
);

Note 1: for drawing vertical lines you must use structured data, because PHP arrays cannot have repeated keys.

Note 2: for drawing multple shapes you must use structured data, because SVGGraph uses structured data internally for multiple datasets and the conversion process will forget the order of keys when they are repeated in different datasets.

See also:

line_figure_closed fill_under

« Back to top of page Main SVGGraph page »