SVGGraph options: best_fit_project_dash

« Return to SVGGraph options page

Option name:
best_fit_project_dash
Default value:
4
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.
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 ScatterGraph StackedLineGraph
Tags:
best-fit trend line

Dash pattern for best-fit line projections.

This option specifies the dash pattern of the projected sections of the best-fit or trend lines. These sections are enabled when using the best_fit_range and best_fit_project options.

The default value of the best_fit_project_dash option is 4 to distinguish the projected sections of line from the main section. The option can be set to NULL to use the same dash pattern as specified for the main section specified with the best_fit_dash option.

Example:

$settings['best_fit_dash'] = 3;
$settings['best_fit_project_dash'] = array('4,2', 5);

This example will draw the main best-fit line using a 3 pixel dash pattern. The projected section for dataset 0 will use a dash pattern with 4 pixels of line and two pixels of space, and the projected section for dataset 1 will use a 5 pixel dash pattern.

For more details of the dash pattern syntax, see the stroke_dash option.

See also:
best_fit_line best_fit_project best_fit_range best_fit_project_colour best_fit_project_width best_fit_project_opacity stroke_dash

« Back to top of page Main SVGGraph page »