SVGGraph options: best_fit_range

« Return to previous page

Option name:

best_fit_range

Default value:

NULL

Added in version:

2.21

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 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:

yes [?]

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:

LineGraph MultiLineGraph MultiScatterGraph MultiSteppedLineGraph ScatterGraph StackedLineGraph SteppedLineGraph

Tags:

best-fit trend line

Range for best-fit lines.

This option specifies a range of X-axis values for the best-fit or trend lines. The value of the option must be an array containing the start and end values of the range:

$settings['best_fit_range'] = array(3, 10);

This example will calculate the line that best fits the values between 3 and 10 on the X-axis. The line will be drawn starting at X = 3 and ending at X = 10 (unless you use the best_fit_project option to extend the line outside the range).

To specify the edge of the grid as either end of the range, use a NULL value:

$settings['best_fit_range'] = array(
  array(NULL, 10),
  array(3, NULL),
  array(NULL, NULL)
);

This example uses a range starting at the left side of the grid and ending at X = 10 for dataset 0, a range starting at X = 3 and ending at the right side of the grid for dataset 1, and a range from the left side of the grid to the right side for dataset 2.

If the values specified are outside the range of the grid, the range is clamped to the grid edges.

See also:: best_fit best_fit_project

« Back to top of page Main SVGGraph page »