| 1 |
<?php |
| 2 |
/** |
| 3 |
* Copyright (C) 2020-2023 Graham Breach |
| 4 |
* |
| 5 |
* This program is free software: you can redistribute it and/or modify |
| 6 |
* it under the terms of the GNU Lesser General Public License as published by |
| 7 |
* the Free Software Foundation, either version 3 of the License, or |
| 8 |
* (at your option) any later version. |
| 9 |
* |
| 10 |
* This program is distributed in the hope that it will be useful, |
| 11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 |
* GNU Lesser General Public License for more details. |
| 14 |
* |
| 15 |
* You should have received a copy of the GNU Lesser General Public License |
| 16 |
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 |
*/ |
| 18 |
/** |
| 19 |
* For more information, please contact <graham@goat1000.com> |
| 20 |
*/ |
| 21 |
|
| 22 |
namespace Goat1000\SVGGraph; |
| 23 |
|
| 24 |
/** |
| 25 |
* Class for average lines (using guidelines) |
| 26 |
*/ |
| 27 |
class Average { |
| 28 |
|
| 29 |
private $graph; |
| 30 |
private $lines = []; |
| 31 |
|
| 32 |
public function __construct(&$graph, &$values, $datasets) |
| 33 |
{ |
| 34 |
foreach($datasets as $d) { |
| 35 |
if(!$graph->getOption(['show_average', $d])) |
| 36 |
continue; |
| 37 |
|
| 38 |
$avg = $this->calculate($values, $d); |
| 39 |
if($avg === null) |
| 40 |
continue; |
| 41 |
|
| 42 |
$line = [ $avg ]; |
| 43 |
|
| 44 |
$title = $this->getTitle($graph, $avg, $d); |
| 45 |
if($title !== null && strlen($title) > 0) |
| 46 |
$line[] = $title; |
| 47 |
|
| 48 |
$cg = new ColourGroup($graph, null, 0, $d, 'average_colour'); |
| 49 |
$line['colour'] = $cg->stroke(); |
| 50 |
|
| 51 |
$tc = $graph->getOption(['average_title_colour', $d]); |
| 52 |
if(!empty($tc)) { |
| 53 |
$cg = new ColourGroup($graph, null, 0, $d, 'average_title_colour'); |
| 54 |
$line['text_colour'] = $cg->stroke(); |
| 55 |
} |
| 56 |
|
| 57 |
$line['stroke_width'] = new Number($graph->getOption(['average_stroke_width', $d], 1)); |
| 58 |
$line['font_size'] = Number::units($graph->getOption(['average_font_size', $d])); |
| 59 |
|
| 60 |
$opts = ["opacity", "above", "dash", "title_align", |
| 61 |
"title_angle", "title_opacity", "title_padding", "title_position", |
| 62 |
"font", "font_adjust", "font_weight", "length", "length_units"]; |
| 63 |
foreach($opts as $opt) { |
| 64 |
$g_opt = str_replace('title', 'text', $opt); |
| 65 |
$line[$g_opt] = $graph->getOption(['average_' . $opt, $d]); |
| 66 |
} |
| 67 |
|
| 68 |
// prevent line from changing graph dimensions |
| 69 |
$line['no_min_max'] = true; |
| 70 |
$this->lines[] = $line; |
| 71 |
} |
| 72 |
|
| 73 |
$this->graph =& $graph; |
| 74 |
} |
| 75 |
|
| 76 |
/** |
| 77 |
* Adds the average lines to the graph's guidelines |
| 78 |
*/ |
| 79 |
public function getGuidelines() |
| 80 |
{ |
| 81 |
if(empty($this->lines)) |
| 82 |
return; |
| 83 |
$guidelines = Guidelines::normalize($this->graph->getOption('guideline')); |
| 84 |
$this->graph->setOption('guideline', array_merge($guidelines, $this->lines)); |
| 85 |
} |
| 86 |
|
| 87 |
/** |
| 88 |
* Calculates the mean average for a dataset |
| 89 |
*/ |
| 90 |
protected function calculate(&$values, $dataset) |
| 91 |
{ |
| 92 |
$sum = 0; |
| 93 |
$count = 0; |
| 94 |
foreach($values[$dataset] as $p) { |
| 95 |
if($p->value === null || !is_numeric($p->value)) |
| 96 |
continue; |
| 97 |
$sum += $p->value; |
| 98 |
++$count; |
| 99 |
} |
| 100 |
|
| 101 |
return $count ? $sum / $count : null; |
| 102 |
} |
| 103 |
|
| 104 |
/** |
| 105 |
* Returns the average line title |
| 106 |
*/ |
| 107 |
protected function getTitle(&$graph, $avg, $dataset) |
| 108 |
{ |
| 109 |
$tcb = $graph->getOption(['average_title_callback', $dataset]); |
| 110 |
if(is_callable($tcb)) |
| 111 |
return call_user_func($tcb, $dataset, $avg); |
| 112 |
|
| 113 |
return $graph->getOption(['average_title', $dataset]); |
| 114 |
} |
| 115 |
} |
| 116 |
|
