1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\ImageGraph\StaticGraph;
use Piwik\Exception\InvalidDimensionException;
use Piwik\Plugins\ImageGraph\StaticGraph;
/**
*
*/
abstract class GridGraph extends StaticGraph
{
public const GRAPHIC_COLOR_KEY = 'GRAPHIC_COLOR';
public const TRUNCATION_TEXT = '...';
public const DEFAULT_TICK_ALPHA = 20;
public const DEFAULT_SERIE_WEIGHT = 0.5;
public const LEFT_GRID_MARGIN = 20;
public const BOTTOM_GRID_MARGIN = 10;
public const TOP_GRID_MARGIN_HORIZONTAL_GRAPH = 10;
public const RIGHT_GRID_MARGIN_HORIZONTAL_GRAPH = 20;
public const OUTER_TICK_WIDTH = 5;
public const INNER_TICK_WIDTH = 0;
public const LABEL_SPACE_VERTICAL_GRAPH = 7;
public const HORIZONTAL_LEGEND_TOP_MARGIN = 5;
public const HORIZONTAL_LEGEND_LEFT_MARGIN = 10;
public const HORIZONTAL_LEGEND_BOTTOM_MARGIN = 10;
public const VERTICAL_LEGEND_TOP_MARGIN = 10;
public const VERTICAL_LEGEND_LEFT_MARGIN = 6;
public const VERTICAL_LEGEND_MAX_WIDTH_PCT = 0.70;
public const LEGEND_LINE_BULLET_WIDTH = 14;
public const LEGEND_BOX_BULLET_WIDTH = 5;
public const LEGEND_BULLET_RIGHT_PADDING = 5;
public const LEGEND_ITEM_HORIZONTAL_INTERSTICE = 6;
public const LEGEND_ITEM_VERTICAL_INTERSTICE_OFFSET = 4;
public const LEGEND_SHADOW_OPACITY = 25;
public const LEGEND_VERTICAL_SHADOW_PADDING = 3;
public const LEGEND_HORIZONTAL_SHADOW_PADDING = 2;
public const PCHART_HARD_CODED_VERTICAL_LEGEND_INTERSTICE = 5;
protected function getDefaultColors()
{
return array(
self::GRAPHIC_COLOR_KEY . '1' => '5170AE',
self::GRAPHIC_COLOR_KEY . '2' => 'F29007',
self::GRAPHIC_COLOR_KEY . '3' => 'CC3399',
self::GRAPHIC_COLOR_KEY . '4' => '9933CC',
self::GRAPHIC_COLOR_KEY . '5' => '80A033',
self::GRAPHIC_COLOR_KEY . '6' => '246AD2',
);
}
protected function initGridChart(
$displayVerticalGridLines,
$bulletType,
$horizontalGraph,
$showTicks,
$verticalLegend
) {
$this->initpData();
$colorIndex = 1;
foreach ($this->ordinateSeries as $column => $data) {
$this->pData->setSerieWeight($column, self::DEFAULT_SERIE_WEIGHT);
$graphicColor = $this->colors[self::GRAPHIC_COLOR_KEY . $colorIndex++];
$this->pData->setPalette($column, $graphicColor);
}
$this->initpImage();
// graph area coordinates
$topLeftXValue = $this->getGridLeftMargin($horizontalGraph, $withLabel = true);
$topLeftYValue = $this->getGridTopMargin($horizontalGraph, $verticalLegend);
$bottomRightXValue = $this->width - $this->getGridRightMargin($horizontalGraph);
$bottomRightYValue = $this->getGraphBottom($horizontalGraph);
$this->drawBackground();
$this->pImage->setGraphArea(
$topLeftXValue,
$topLeftYValue,
$bottomRightXValue,
$bottomRightYValue
);
// determine how many labels need to be skipped
$skippedLabels = 0;
if (!$horizontalGraph) {
list($abscissaMaxWidth, $abscissaMaxHeight) = $this->getMaximumTextWidthHeight($this->abscissaSeries);
$graphWidth = $bottomRightXValue - $topLeftXValue;
$maxNumOfLabels = floor($graphWidth / ($abscissaMaxWidth + self::LABEL_SPACE_VERTICAL_GRAPH));
$abscissaSeriesCount = count($this->abscissaSeries);
if ($maxNumOfLabels < $abscissaSeriesCount) {
for ($candidateSkippedLabels = 1; $candidateSkippedLabels < $abscissaSeriesCount; $candidateSkippedLabels++) {
$numberOfSegments = $abscissaSeriesCount / ($candidateSkippedLabels + 1);
$numberOfCompleteSegments = floor($numberOfSegments);
$numberOfLabels = $numberOfCompleteSegments;
if ($numberOfSegments > $numberOfCompleteSegments) {
$numberOfLabels++;
}
if ($numberOfLabels <= $maxNumOfLabels) {
$skippedLabels = $candidateSkippedLabels;
break;
}
}
}
if (
$this->forceSkippedLabels
&& $skippedLabels
&& $skippedLabels < $this->forceSkippedLabels
&& $abscissaSeriesCount > $this->forceSkippedLabels + 1
) {
$skippedLabels = $this->forceSkippedLabels;
}
}
$ordinateAxisLength =
$horizontalGraph ? $bottomRightXValue - $topLeftXValue : $this->getGraphHeight($horizontalGraph, $verticalLegend);
$maxOrdinateValue = 0;
foreach ($this->ordinateSeries as $column => $data) {
$currentMax = $this->pData->getMax($column);
if ($currentMax > $maxOrdinateValue) {
$maxOrdinateValue = ceil($currentMax);
}
}
// rounding top scale value to the next multiple of 10
if ($maxOrdinateValue > 10) {
$modTen = $maxOrdinateValue % 10;
if ($modTen) {
$maxOrdinateValue += 10 - $modTen;
}
}
if ($ordinateAxisLength <= 0 || $bottomRightYValue - $topLeftYValue <= 0) {
throw new InvalidDimensionException('Error: the graph dimension is not valid. Please try larger width and height values or use 0 for default values.');
}
$gridColor = $this->gridColor;
$this->pImage->drawScale(
array(
'Mode' => SCALE_MODE_MANUAL,
'GridTicks' => 0,
'LabelSkip' => $skippedLabels,
'DrawXLines' => $displayVerticalGridLines,
'Factors' => array(ceil($maxOrdinateValue / 2)),
'MinDivHeight' => $ordinateAxisLength / 2,
'AxisAlpha' => 0,
'SkippedAxisAlpha' => 0,
'TickAlpha' => $showTicks ? self::DEFAULT_TICK_ALPHA : 0,
'InnerTickWidth' => self::INNER_TICK_WIDTH,
'OuterTickWidth' => self::OUTER_TICK_WIDTH,
'GridR' => $gridColor['R'],
'GridG' => $gridColor['G'],
'GridB' => $gridColor['B'],
'GridAlpha' => 100,
'ManualScale' => array(
0 => array(
'Min' => 0,
'Max' => $maxOrdinateValue,
),
),
'Pos' => $horizontalGraph ? SCALE_POS_TOPBOTTOM : SCALE_POS_LEFTRIGHT,
)
);
if ($this->showLegend) {
switch ($bulletType) {
case LEGEND_FAMILY_LINE:
$bulletWidth = self::LEGEND_LINE_BULLET_WIDTH;
// measured using a picture editing software
$iconOffsetAboveLabelSymmetryAxis = -2;
break;
case LEGEND_FAMILY_BOX:
$bulletWidth = self::LEGEND_BOX_BULLET_WIDTH;
// measured using a picture editing software
$iconOffsetAboveLabelSymmetryAxis = 3;
break;
}
// pChart requires two coordinates to draw the legend $legendTopLeftXValue & $legendTopLeftYValue
// $legendTopLeftXValue = legend's left padding
$legendTopLeftXValue = $topLeftXValue + ($verticalLegend ? self::VERTICAL_LEGEND_LEFT_MARGIN : self::HORIZONTAL_LEGEND_LEFT_MARGIN);
// $legendTopLeftYValue = y coordinate of the top edge of the legend's icons
// Caution :
// - pChart will silently add some value (see $paddingAddedByPChart) to $legendTopLeftYValue depending on multiple criteria
// - pChart will not take into account the size of the text. Setting $legendTopLeftYValue = 0 will crop the legend's labels
// The following section of code determines the value of $legendTopLeftYValue while taking into account the following parameters :
// - whether legend items have icons
// - whether icons are bigger than the legend's labels
// - how much colored shadow padding is required
list($maxLogoWidth, $maxLogoHeight) = self::getMaxLogoSize(array_values($this->ordinateLogos));
if ($maxLogoHeight >= $this->legendFontSize) {
$heightOfTextAboveBulletTop = 0;
$paddingCreatedByLogo = $maxLogoHeight - $this->legendFontSize;
$effectiveShadowPadding = $paddingCreatedByLogo < self::LEGEND_VERTICAL_SHADOW_PADDING * 2 ? self::LEGEND_VERTICAL_SHADOW_PADDING - ($paddingCreatedByLogo / 2) : 0;
} else {
if ($maxLogoHeight) {
// measured using a picture editing software
$iconOffsetAboveLabelSymmetryAxis = 5;
}
$heightOfTextAboveBulletTop = $this->legendFontSize / 2 - $iconOffsetAboveLabelSymmetryAxis;
$effectiveShadowPadding = self::LEGEND_VERTICAL_SHADOW_PADDING;
}
$effectiveLegendItemVerticalInterstice = $this->legendFontSize + self::LEGEND_ITEM_VERTICAL_INTERSTICE_OFFSET;
$effectiveLegendItemHorizontalInterstice = self::LEGEND_ITEM_HORIZONTAL_INTERSTICE + self::LEGEND_HORIZONTAL_SHADOW_PADDING;
$legendTopMargin = $verticalLegend ? self::VERTICAL_LEGEND_TOP_MARGIN : self::HORIZONTAL_LEGEND_TOP_MARGIN;
$requiredPaddingAboveItemBullet = $legendTopMargin + $heightOfTextAboveBulletTop + $effectiveShadowPadding;
$paddingAddedByPChart = 0;
if ($verticalLegend) {
if ($maxLogoHeight) {
// see line 1691 of pDraw.class.php
if ($maxLogoHeight < $effectiveLegendItemVerticalInterstice) {
$paddingAddedByPChart = ($effectiveLegendItemVerticalInterstice / 2) - ($maxLogoHeight / 2);
}
} else {
// see line 1711 of pDraw.class.php ($Y+$IconAreaHeight/2)
$paddingAddedByPChart = $effectiveLegendItemVerticalInterstice / 2;
}
}
$legendTopLeftYValue = $paddingAddedByPChart < $requiredPaddingAboveItemBullet ? $requiredPaddingAboveItemBullet - $paddingAddedByPChart : 0;
// add colored background to each legend item
if (count($this->ordinateLabels) > 1) {
$currentPosition = $verticalLegend ? $legendTopMargin : $legendTopLeftXValue;
$colorIndex = 1;
foreach ($this->ordinateLabels as $metricCode => &$label) {
$color = $this->colors[self::GRAPHIC_COLOR_KEY . $colorIndex++];
$paddedBulletWidth = $bulletWidth;
if (isset($this->ordinateLogos[$metricCode])) {
$paddedBulletWidth = $maxLogoWidth;
}
$paddedBulletWidth += self::LEGEND_BULLET_RIGHT_PADDING;
// truncate labels if required
if ($verticalLegend) {
$label = $this->truncateLabel($label, ($this->width * self::VERTICAL_LEGEND_MAX_WIDTH_PCT) - $legendTopLeftXValue - $paddedBulletWidth, $this->legendFontSize);
$this->pData->setSerieDescription($metricCode, $label);
}
$rectangleTopLeftXValue = ($verticalLegend ? $legendTopLeftXValue : $currentPosition) + $paddedBulletWidth - self::LEGEND_HORIZONTAL_SHADOW_PADDING;
$rectangleTopLeftYValue = $verticalLegend ? $currentPosition : $legendTopMargin;
list($labelWidth, $labelHeight) = $this->getTextWidthHeight($label, $this->legendFontSize);
$legendItemWidth = $paddedBulletWidth + $labelWidth + $effectiveLegendItemHorizontalInterstice;
$rectangleBottomRightXValue = $rectangleTopLeftXValue + $labelWidth + (self::LEGEND_HORIZONTAL_SHADOW_PADDING * 2);
$legendItemHeight = max($maxLogoHeight, $this->legendFontSize) + ($effectiveShadowPadding * 2);
$rectangleBottomRightYValue = $rectangleTopLeftYValue + $legendItemHeight;
$this->pImage->drawFilledRectangle(
$rectangleTopLeftXValue,
$rectangleTopLeftYValue,
$rectangleBottomRightXValue,
$rectangleBottomRightYValue,
array(
'Alpha' => self::LEGEND_SHADOW_OPACITY,
'R' => $color['R'],
'G' => $color['G'],
'B' => $color['B'],
)
);
if ($verticalLegend) {
$currentPositionIncrement = max($maxLogoHeight, $effectiveLegendItemVerticalInterstice, $this->legendFontSize) + self::PCHART_HARD_CODED_VERTICAL_LEGEND_INTERSTICE;
} else {
$currentPositionIncrement = $legendItemWidth;
}
$currentPosition += $currentPositionIncrement;
}
}
// draw legend
$legendColor = $this->textColor;
$this->pImage->drawLegend(
$legendTopLeftXValue,
$legendTopLeftYValue,
array(
'Style' => LEGEND_NOBORDER,
'FontSize' => $this->legendFontSize,
'BoxWidth' => $bulletWidth,
'XSpacing' => $effectiveLegendItemHorizontalInterstice, // not effective when vertical
'Mode' => $verticalLegend ? LEGEND_VERTICAL : LEGEND_HORIZONTAL,
'BoxHeight' => $verticalLegend ? $effectiveLegendItemVerticalInterstice : null,
'Family' => $bulletType,
'FontR' => $legendColor['R'],
'FontG' => $legendColor['G'],
'FontB' => $legendColor['B'],
)
);
}
}
protected static function getMaxLogoSize($logoPaths)
{
$maxLogoWidth = 0;
$maxLogoHeight = 0;
foreach ($logoPaths as $logoPath) {
list($logoWidth, $logoHeight) = self::getLogoSize($logoPath);
if ($logoWidth > $maxLogoWidth) {
$maxLogoWidth = $logoWidth;
}
if ($logoHeight > $maxLogoHeight) {
$maxLogoHeight = $logoHeight;
}
}
return array($maxLogoWidth, $maxLogoHeight);
}
protected static function getLogoSize($logoPath)
{
$pathInfo = getimagesize($logoPath);
return array($pathInfo[0], $pathInfo[1]);
}
protected function getGridLeftMargin($horizontalGraph, $withLabel)
{
$gridLeftMargin = self::LEFT_GRID_MARGIN + self::OUTER_TICK_WIDTH;
if ($withLabel) {
list($maxTextWidth, $maxTextHeight) = $this->getMaximumTextWidthHeight($horizontalGraph ? $this->abscissaSeries : $this->ordinateSeries);
$gridLeftMargin += $maxTextWidth;
}
return $gridLeftMargin;
}
protected function getGridTopMargin($horizontalGraph, $verticalLegend)
{
list($ordinateMaxWidth, $ordinateMaxHeight) = $this->getMaximumTextWidthHeight($this->ordinateSeries);
if ($horizontalGraph) {
$topMargin = $ordinateMaxHeight + self::TOP_GRID_MARGIN_HORIZONTAL_GRAPH + self::OUTER_TICK_WIDTH;
} else {
$topMargin = $ordinateMaxHeight / 2 + self::TOP_GRID_MARGIN_HORIZONTAL_GRAPH;
}
if ($this->showLegend && !$verticalLegend) {
$topMargin += $this->getHorizontalLegendHeight();
}
return $topMargin;
}
private function getHorizontalLegendHeight()
{
list($maxMetricLegendWidth, $maxMetricLegendHeight) =
$this->getMaximumTextWidthHeight(array_values($this->ordinateLabels));
return $maxMetricLegendHeight + self::HORIZONTAL_LEGEND_BOTTOM_MARGIN + self::HORIZONTAL_LEGEND_TOP_MARGIN;
}
protected function getGraphHeight($horizontalGraph, $verticalLegend)
{
return $this->getGraphBottom($horizontalGraph) - $this->getGridTopMargin($horizontalGraph, $verticalLegend);
}
private function getGridBottomMargin($horizontalGraph)
{
$gridBottomMargin = self::BOTTOM_GRID_MARGIN;
if (!$horizontalGraph) {
list($abscissaMaxWidth, $abscissaMaxHeight) = $this->getMaximumTextWidthHeight($this->abscissaSeries);
$gridBottomMargin += $abscissaMaxHeight;
}
return $gridBottomMargin;
}
protected function getGridRightMargin($horizontalGraph)
{
if ($horizontalGraph) {
// in horizontal graphs, metric values are displayed on the far right of the bar
list($ordinateMaxWidth, $ordinateMaxHeight) = $this->getMaximumTextWidthHeight($this->ordinateSeries);
return self::RIGHT_GRID_MARGIN_HORIZONTAL_GRAPH + $ordinateMaxWidth;
} else {
return self::RIGHT_GRID_MARGIN_HORIZONTAL_GRAPH;
}
}
protected function getGraphBottom($horizontalGraph)
{
return $this->height - $this->getGridBottomMargin($horizontalGraph);
}
protected function truncateLabel($label, $labelWidthLimit, $fontSize = false)
{
list($truncationTextWidth, $truncationTextHeight) = $this->getTextWidthHeight(self::TRUNCATION_TEXT, $fontSize);
list($labelWidth, $labelHeight) = $this->getTextWidthHeight($label, $fontSize);
if ($labelWidth > $labelWidthLimit) {
$averageCharWidth = $labelWidth / strlen($label);
$charsToKeep = floor(($labelWidthLimit - $truncationTextWidth) / $averageCharWidth);
$label = substr($label, 0, $charsToKeep) . self::TRUNCATION_TEXT;
}
return $label;
}
// display min & max values
// can not currently be used because pChart's label design is not flexible enough
// e.g: it is not possible to remove the box border & the square icon
// it would require modifying pChart code base which we try to avoid
// see https://github.com/piwik/piwik/issues/3396
// protected function displayMinMaxValues()
// {
// if ($displayMinMax)
// {
// // when plotting multiple metrics, display min & max on both series
// // to fix: in vertical bars, labels are hidden when multiple metrics are plotted, hence the restriction on count($this->ordinateSeries) == 1
// if ($this->multipleMetrics && count($this->ordinateSeries) == 1)
// {
// $colorIndex = 1;
// foreach($this->ordinateSeries as $column => $data)
// {
// $color = $this->colors[self::GRAPHIC_COLOR_KEY . $colorIndex++];
//
// $this->pImage->writeLabel(
// $column,
// self::locateMinMaxValue($data),
// $Format = array(
// 'NoTitle' => true,
// 'DrawPoint' => false,
// 'DrawSerieColor' => true,
// 'TitleMode' => LABEL_TITLE_NOBACKGROUND,
// 'GradientStartR' => $color['R'],
// 'GradientStartG' => $color['G'],
// 'GradientStartB' => $color['B'],
// 'GradientEndR' => 255,
// 'GradientEndG' => 255,
// 'GradientEndB' => 255,
// 'BoxWidth' => 0,
// 'VerticalMargin' => 9,
// 'HorizontalMargin' => 7,
// )
// );
// }
// }
// else
// {
// // display only one min & max label
// }
// }
// }
// protected static function locateMinMaxValue($data)
// {
// $firstValue = $data[0];
// $minValue = $firstValue;
// $minValueIndex = 0;
// $maxValue = $firstValue;
// $maxValueIndex = 0;
// foreach($data as $index => $value)
// {
// if ($value > $maxValue)
// {
// $maxValue = $value;
// $maxValueIndex = $index;
// }
//
// if ($value < $minValue)
// {
// $minValue = $value;
// $minValueIndex = $index;
// }
// }
//
// return array($minValueIndex, $maxValueIndex);
// }
}
|
