SVGGraph options: best_fit_project

« Return to previous page

Option name:

best_fit_project

Default value:

NULL

Added in version:

2.21

Data type:

string [?]

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

Best-fit line projections.

This option specifies whether the best-fit or trend lines project outside the range set using the best_fit_range option. The default value NULL means the line is not extended past the specified range.

These values are supported for projecting the different ends of the best-fit lines:

"start"

The line is extended between the left side of the grid and the start of the range.
"end"

The line is extended between the end of the range and the right side of the grid.
"both"

The line is extended at both ends to meet the left and right sides of the grid.

Example:

$settings['best_fit_project'] = array("end", "both", NULL);

This example extends the end of the dataset 0 best-fit line to the right side of the grid, extends both ends of the dataset 1 line to either side of the grid and does not extend the best-fit line for dataset 2 at all.

The projected parts of the best-fit lines are drawn with a dash pattern by default to show where the sections of line are not based on any markers with the same X value. The best_fit_project_dash, best_fit_project_colour, best_fit_project_width and best_fit_project_opacity options can be used to adjust the appearance of the projected parts of the lines.

See also:: best_fit best_fit_range best_fit_project_dash best_fit_project_colour best_fit_project_width best_fit_project_opacity

« Back to top of page Main SVGGraph page »