Chart.php 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569
  1. <?php
  2. namespace PhpOffice\PhpSpreadsheet\Reader\Xlsx;
  3. use PhpOffice\PhpSpreadsheet\Calculation\Functions;
  4. use PhpOffice\PhpSpreadsheet\Chart\DataSeries;
  5. use PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues;
  6. use PhpOffice\PhpSpreadsheet\Chart\Layout;
  7. use PhpOffice\PhpSpreadsheet\Chart\Legend;
  8. use PhpOffice\PhpSpreadsheet\Chart\PlotArea;
  9. use PhpOffice\PhpSpreadsheet\Chart\Title;
  10. use PhpOffice\PhpSpreadsheet\RichText\RichText;
  11. use PhpOffice\PhpSpreadsheet\Style\Color;
  12. use PhpOffice\PhpSpreadsheet\Style\Font;
  13. use SimpleXMLElement;
  14. class Chart
  15. {
  16. /**
  17. * @param SimpleXMLElement $component
  18. * @param string $name
  19. * @param string $format
  20. *
  21. * @return null|bool|float|int|string
  22. */
  23. private static function getAttribute(SimpleXMLElement $component, $name, $format)
  24. {
  25. $attributes = $component->attributes();
  26. if (isset($attributes[$name])) {
  27. if ($format == 'string') {
  28. return (string) $attributes[$name];
  29. } elseif ($format == 'integer') {
  30. return (int) $attributes[$name];
  31. } elseif ($format == 'boolean') {
  32. return (bool) ($attributes[$name] === '0' || $attributes[$name] !== 'true') ? false : true;
  33. }
  34. return (float) $attributes[$name];
  35. }
  36. return null;
  37. }
  38. private static function readColor($color, $background = false)
  39. {
  40. if (isset($color['rgb'])) {
  41. return (string) $color['rgb'];
  42. } elseif (isset($color['indexed'])) {
  43. return Color::indexedColor($color['indexed'] - 7, $background)->getARGB();
  44. }
  45. }
  46. /**
  47. * @param SimpleXMLElement $chartElements
  48. * @param string $chartName
  49. *
  50. * @return \PhpOffice\PhpSpreadsheet\Chart\Chart
  51. */
  52. public static function readChart(SimpleXMLElement $chartElements, $chartName)
  53. {
  54. $namespacesChartMeta = $chartElements->getNamespaces(true);
  55. $chartElementsC = $chartElements->children($namespacesChartMeta['c']);
  56. $XaxisLabel = $YaxisLabel = $legend = $title = null;
  57. $dispBlanksAs = $plotVisOnly = null;
  58. foreach ($chartElementsC as $chartElementKey => $chartElement) {
  59. switch ($chartElementKey) {
  60. case 'chart':
  61. foreach ($chartElement as $chartDetailsKey => $chartDetails) {
  62. $chartDetailsC = $chartDetails->children($namespacesChartMeta['c']);
  63. switch ($chartDetailsKey) {
  64. case 'plotArea':
  65. $plotAreaLayout = $XaxisLable = $YaxisLable = null;
  66. $plotSeries = $plotAttributes = [];
  67. foreach ($chartDetails as $chartDetailKey => $chartDetail) {
  68. switch ($chartDetailKey) {
  69. case 'layout':
  70. $plotAreaLayout = self::chartLayoutDetails($chartDetail, $namespacesChartMeta);
  71. break;
  72. case 'catAx':
  73. if (isset($chartDetail->title)) {
  74. $XaxisLabel = self::chartTitle($chartDetail->title->children($namespacesChartMeta['c']), $namespacesChartMeta);
  75. }
  76. break;
  77. case 'dateAx':
  78. if (isset($chartDetail->title)) {
  79. $XaxisLabel = self::chartTitle($chartDetail->title->children($namespacesChartMeta['c']), $namespacesChartMeta);
  80. }
  81. break;
  82. case 'valAx':
  83. if (isset($chartDetail->title)) {
  84. $YaxisLabel = self::chartTitle($chartDetail->title->children($namespacesChartMeta['c']), $namespacesChartMeta);
  85. }
  86. break;
  87. case 'barChart':
  88. case 'bar3DChart':
  89. $barDirection = self::getAttribute($chartDetail->barDir, 'val', 'string');
  90. $plotSer = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  91. $plotSer->setPlotDirection($barDirection);
  92. $plotSeries[] = $plotSer;
  93. $plotAttributes = self::readChartAttributes($chartDetail);
  94. break;
  95. case 'lineChart':
  96. case 'line3DChart':
  97. $plotSeries[] = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  98. $plotAttributes = self::readChartAttributes($chartDetail);
  99. break;
  100. case 'areaChart':
  101. case 'area3DChart':
  102. $plotSeries[] = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  103. $plotAttributes = self::readChartAttributes($chartDetail);
  104. break;
  105. case 'doughnutChart':
  106. case 'pieChart':
  107. case 'pie3DChart':
  108. $explosion = isset($chartDetail->ser->explosion);
  109. $plotSer = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  110. $plotSer->setPlotStyle($explosion);
  111. $plotSeries[] = $plotSer;
  112. $plotAttributes = self::readChartAttributes($chartDetail);
  113. break;
  114. case 'scatterChart':
  115. $scatterStyle = self::getAttribute($chartDetail->scatterStyle, 'val', 'string');
  116. $plotSer = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  117. $plotSer->setPlotStyle($scatterStyle);
  118. $plotSeries[] = $plotSer;
  119. $plotAttributes = self::readChartAttributes($chartDetail);
  120. break;
  121. case 'bubbleChart':
  122. $bubbleScale = self::getAttribute($chartDetail->bubbleScale, 'val', 'integer');
  123. $plotSer = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  124. $plotSer->setPlotStyle($bubbleScale);
  125. $plotSeries[] = $plotSer;
  126. $plotAttributes = self::readChartAttributes($chartDetail);
  127. break;
  128. case 'radarChart':
  129. $radarStyle = self::getAttribute($chartDetail->radarStyle, 'val', 'string');
  130. $plotSer = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  131. $plotSer->setPlotStyle($radarStyle);
  132. $plotSeries[] = $plotSer;
  133. $plotAttributes = self::readChartAttributes($chartDetail);
  134. break;
  135. case 'surfaceChart':
  136. case 'surface3DChart':
  137. $wireFrame = self::getAttribute($chartDetail->wireframe, 'val', 'boolean');
  138. $plotSer = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  139. $plotSer->setPlotStyle($wireFrame);
  140. $plotSeries[] = $plotSer;
  141. $plotAttributes = self::readChartAttributes($chartDetail);
  142. break;
  143. case 'stockChart':
  144. $plotSeries[] = self::chartDataSeries($chartDetail, $namespacesChartMeta, $chartDetailKey);
  145. $plotAttributes = self::readChartAttributes($plotAreaLayout);
  146. break;
  147. }
  148. }
  149. if ($plotAreaLayout == null) {
  150. $plotAreaLayout = new Layout();
  151. }
  152. $plotArea = new PlotArea($plotAreaLayout, $plotSeries);
  153. self::setChartAttributes($plotAreaLayout, $plotAttributes);
  154. break;
  155. case 'plotVisOnly':
  156. $plotVisOnly = self::getAttribute($chartDetails, 'val', 'string');
  157. break;
  158. case 'dispBlanksAs':
  159. $dispBlanksAs = self::getAttribute($chartDetails, 'val', 'string');
  160. break;
  161. case 'title':
  162. $title = self::chartTitle($chartDetails, $namespacesChartMeta);
  163. break;
  164. case 'legend':
  165. $legendPos = 'r';
  166. $legendLayout = null;
  167. $legendOverlay = false;
  168. foreach ($chartDetails as $chartDetailKey => $chartDetail) {
  169. switch ($chartDetailKey) {
  170. case 'legendPos':
  171. $legendPos = self::getAttribute($chartDetail, 'val', 'string');
  172. break;
  173. case 'overlay':
  174. $legendOverlay = self::getAttribute($chartDetail, 'val', 'boolean');
  175. break;
  176. case 'layout':
  177. $legendLayout = self::chartLayoutDetails($chartDetail, $namespacesChartMeta);
  178. break;
  179. }
  180. }
  181. $legend = new Legend($legendPos, $legendLayout, $legendOverlay);
  182. break;
  183. }
  184. }
  185. }
  186. }
  187. $chart = new \PhpOffice\PhpSpreadsheet\Chart\Chart($chartName, $title, $legend, $plotArea, $plotVisOnly, $dispBlanksAs, $XaxisLabel, $YaxisLabel);
  188. return $chart;
  189. }
  190. private static function chartTitle(SimpleXMLElement $titleDetails, array $namespacesChartMeta)
  191. {
  192. $caption = [];
  193. $titleLayout = null;
  194. foreach ($titleDetails as $titleDetailKey => $chartDetail) {
  195. switch ($titleDetailKey) {
  196. case 'tx':
  197. $titleDetails = $chartDetail->rich->children($namespacesChartMeta['a']);
  198. foreach ($titleDetails as $titleKey => $titleDetail) {
  199. switch ($titleKey) {
  200. case 'p':
  201. $titleDetailPart = $titleDetail->children($namespacesChartMeta['a']);
  202. $caption[] = self::parseRichText($titleDetailPart);
  203. }
  204. }
  205. break;
  206. case 'layout':
  207. $titleLayout = self::chartLayoutDetails($chartDetail, $namespacesChartMeta);
  208. break;
  209. }
  210. }
  211. return new Title($caption, $titleLayout);
  212. }
  213. private static function chartLayoutDetails($chartDetail, $namespacesChartMeta)
  214. {
  215. if (!isset($chartDetail->manualLayout)) {
  216. return null;
  217. }
  218. $details = $chartDetail->manualLayout->children($namespacesChartMeta['c']);
  219. if ($details === null) {
  220. return null;
  221. }
  222. $layout = [];
  223. foreach ($details as $detailKey => $detail) {
  224. $layout[$detailKey] = self::getAttribute($detail, 'val', 'string');
  225. }
  226. return new Layout($layout);
  227. }
  228. private static function chartDataSeries($chartDetail, $namespacesChartMeta, $plotType)
  229. {
  230. $multiSeriesType = null;
  231. $smoothLine = false;
  232. $seriesLabel = $seriesCategory = $seriesValues = $plotOrder = [];
  233. $seriesDetailSet = $chartDetail->children($namespacesChartMeta['c']);
  234. foreach ($seriesDetailSet as $seriesDetailKey => $seriesDetails) {
  235. switch ($seriesDetailKey) {
  236. case 'grouping':
  237. $multiSeriesType = self::getAttribute($chartDetail->grouping, 'val', 'string');
  238. break;
  239. case 'ser':
  240. $marker = null;
  241. foreach ($seriesDetails as $seriesKey => $seriesDetail) {
  242. switch ($seriesKey) {
  243. case 'idx':
  244. $seriesIndex = self::getAttribute($seriesDetail, 'val', 'integer');
  245. break;
  246. case 'order':
  247. $seriesOrder = self::getAttribute($seriesDetail, 'val', 'integer');
  248. $plotOrder[$seriesIndex] = $seriesOrder;
  249. break;
  250. case 'tx':
  251. $seriesLabel[$seriesIndex] = self::chartDataSeriesValueSet($seriesDetail, $namespacesChartMeta);
  252. break;
  253. case 'marker':
  254. $marker = self::getAttribute($seriesDetail->symbol, 'val', 'string');
  255. break;
  256. case 'smooth':
  257. $smoothLine = self::getAttribute($seriesDetail, 'val', 'boolean');
  258. break;
  259. case 'cat':
  260. $seriesCategory[$seriesIndex] = self::chartDataSeriesValueSet($seriesDetail, $namespacesChartMeta);
  261. break;
  262. case 'val':
  263. $seriesValues[$seriesIndex] = self::chartDataSeriesValueSet($seriesDetail, $namespacesChartMeta, $marker);
  264. break;
  265. case 'xVal':
  266. $seriesCategory[$seriesIndex] = self::chartDataSeriesValueSet($seriesDetail, $namespacesChartMeta, $marker);
  267. break;
  268. case 'yVal':
  269. $seriesValues[$seriesIndex] = self::chartDataSeriesValueSet($seriesDetail, $namespacesChartMeta, $marker);
  270. break;
  271. }
  272. }
  273. }
  274. }
  275. return new DataSeries($plotType, $multiSeriesType, $plotOrder, $seriesLabel, $seriesCategory, $seriesValues, $smoothLine);
  276. }
  277. private static function chartDataSeriesValueSet($seriesDetail, $namespacesChartMeta, $marker = null)
  278. {
  279. if (isset($seriesDetail->strRef)) {
  280. $seriesSource = (string) $seriesDetail->strRef->f;
  281. $seriesData = self::chartDataSeriesValues($seriesDetail->strRef->strCache->children($namespacesChartMeta['c']), 's');
  282. return new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING, $seriesSource, $seriesData['formatCode'], $seriesData['pointCount'], $seriesData['dataValues'], $marker);
  283. } elseif (isset($seriesDetail->numRef)) {
  284. $seriesSource = (string) $seriesDetail->numRef->f;
  285. $seriesData = self::chartDataSeriesValues($seriesDetail->numRef->numCache->children($namespacesChartMeta['c']));
  286. return new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_NUMBER, $seriesSource, $seriesData['formatCode'], $seriesData['pointCount'], $seriesData['dataValues'], $marker);
  287. } elseif (isset($seriesDetail->multiLvlStrRef)) {
  288. $seriesSource = (string) $seriesDetail->multiLvlStrRef->f;
  289. $seriesData = self::chartDataSeriesValuesMultiLevel($seriesDetail->multiLvlStrRef->multiLvlStrCache->children($namespacesChartMeta['c']), 's');
  290. $seriesData['pointCount'] = count($seriesData['dataValues']);
  291. return new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING, $seriesSource, $seriesData['formatCode'], $seriesData['pointCount'], $seriesData['dataValues'], $marker);
  292. } elseif (isset($seriesDetail->multiLvlNumRef)) {
  293. $seriesSource = (string) $seriesDetail->multiLvlNumRef->f;
  294. $seriesData = self::chartDataSeriesValuesMultiLevel($seriesDetail->multiLvlNumRef->multiLvlNumCache->children($namespacesChartMeta['c']), 's');
  295. $seriesData['pointCount'] = count($seriesData['dataValues']);
  296. return new DataSeriesValues(DataSeriesValues::DATASERIES_TYPE_STRING, $seriesSource, $seriesData['formatCode'], $seriesData['pointCount'], $seriesData['dataValues'], $marker);
  297. }
  298. return null;
  299. }
  300. private static function chartDataSeriesValues($seriesValueSet, $dataType = 'n')
  301. {
  302. $seriesVal = [];
  303. $formatCode = '';
  304. $pointCount = 0;
  305. foreach ($seriesValueSet as $seriesValueIdx => $seriesValue) {
  306. switch ($seriesValueIdx) {
  307. case 'ptCount':
  308. $pointCount = self::getAttribute($seriesValue, 'val', 'integer');
  309. break;
  310. case 'formatCode':
  311. $formatCode = (string) $seriesValue;
  312. break;
  313. case 'pt':
  314. $pointVal = self::getAttribute($seriesValue, 'idx', 'integer');
  315. if ($dataType == 's') {
  316. $seriesVal[$pointVal] = (string) $seriesValue->v;
  317. } elseif ($seriesValue->v === Functions::NA()) {
  318. $seriesVal[$pointVal] = null;
  319. } else {
  320. $seriesVal[$pointVal] = (float) $seriesValue->v;
  321. }
  322. break;
  323. }
  324. }
  325. return [
  326. 'formatCode' => $formatCode,
  327. 'pointCount' => $pointCount,
  328. 'dataValues' => $seriesVal,
  329. ];
  330. }
  331. private static function chartDataSeriesValuesMultiLevel($seriesValueSet, $dataType = 'n')
  332. {
  333. $seriesVal = [];
  334. $formatCode = '';
  335. $pointCount = 0;
  336. foreach ($seriesValueSet->lvl as $seriesLevelIdx => $seriesLevel) {
  337. foreach ($seriesLevel as $seriesValueIdx => $seriesValue) {
  338. switch ($seriesValueIdx) {
  339. case 'ptCount':
  340. $pointCount = self::getAttribute($seriesValue, 'val', 'integer');
  341. break;
  342. case 'formatCode':
  343. $formatCode = (string) $seriesValue;
  344. break;
  345. case 'pt':
  346. $pointVal = self::getAttribute($seriesValue, 'idx', 'integer');
  347. if ($dataType == 's') {
  348. $seriesVal[$pointVal][] = (string) $seriesValue->v;
  349. } elseif ($seriesValue->v === Functions::NA()) {
  350. $seriesVal[$pointVal] = null;
  351. } else {
  352. $seriesVal[$pointVal][] = (float) $seriesValue->v;
  353. }
  354. break;
  355. }
  356. }
  357. }
  358. return [
  359. 'formatCode' => $formatCode,
  360. 'pointCount' => $pointCount,
  361. 'dataValues' => $seriesVal,
  362. ];
  363. }
  364. private static function parseRichText(SimpleXMLElement $titleDetailPart)
  365. {
  366. $value = new RichText();
  367. foreach ($titleDetailPart as $titleDetailElementKey => $titleDetailElement) {
  368. if (isset($titleDetailElement->t)) {
  369. $objText = $value->createTextRun((string) $titleDetailElement->t);
  370. }
  371. if (isset($titleDetailElement->rPr)) {
  372. if (isset($titleDetailElement->rPr->rFont['val'])) {
  373. $objText->getFont()->setName((string) $titleDetailElement->rPr->rFont['val']);
  374. }
  375. $fontSize = (self::getAttribute($titleDetailElement->rPr, 'sz', 'integer'));
  376. if ($fontSize !== null) {
  377. $objText->getFont()->setSize(floor($fontSize / 100));
  378. }
  379. $fontColor = (self::getAttribute($titleDetailElement->rPr, 'color', 'string'));
  380. if ($fontColor !== null) {
  381. $objText->getFont()->setColor(new Color(self::readColor($fontColor)));
  382. }
  383. $bold = self::getAttribute($titleDetailElement->rPr, 'b', 'boolean');
  384. if ($bold !== null) {
  385. $objText->getFont()->setBold($bold);
  386. }
  387. $italic = self::getAttribute($titleDetailElement->rPr, 'i', 'boolean');
  388. if ($italic !== null) {
  389. $objText->getFont()->setItalic($italic);
  390. }
  391. $baseline = self::getAttribute($titleDetailElement->rPr, 'baseline', 'integer');
  392. if ($baseline !== null) {
  393. if ($baseline > 0) {
  394. $objText->getFont()->setSuperscript(true);
  395. } elseif ($baseline < 0) {
  396. $objText->getFont()->setSubscript(true);
  397. }
  398. }
  399. $underscore = (self::getAttribute($titleDetailElement->rPr, 'u', 'string'));
  400. if ($underscore !== null) {
  401. if ($underscore == 'sng') {
  402. $objText->getFont()->setUnderline(Font::UNDERLINE_SINGLE);
  403. } elseif ($underscore == 'dbl') {
  404. $objText->getFont()->setUnderline(Font::UNDERLINE_DOUBLE);
  405. } else {
  406. $objText->getFont()->setUnderline(Font::UNDERLINE_NONE);
  407. }
  408. }
  409. $strikethrough = (self::getAttribute($titleDetailElement->rPr, 's', 'string'));
  410. if ($strikethrough !== null) {
  411. if ($strikethrough == 'noStrike') {
  412. $objText->getFont()->setStrikethrough(false);
  413. } else {
  414. $objText->getFont()->setStrikethrough(true);
  415. }
  416. }
  417. }
  418. }
  419. return $value;
  420. }
  421. private static function readChartAttributes($chartDetail)
  422. {
  423. $plotAttributes = [];
  424. if (isset($chartDetail->dLbls)) {
  425. if (isset($chartDetail->dLbls->howLegendKey)) {
  426. $plotAttributes['showLegendKey'] = self::getAttribute($chartDetail->dLbls->showLegendKey, 'val', 'string');
  427. }
  428. if (isset($chartDetail->dLbls->showVal)) {
  429. $plotAttributes['showVal'] = self::getAttribute($chartDetail->dLbls->showVal, 'val', 'string');
  430. }
  431. if (isset($chartDetail->dLbls->showCatName)) {
  432. $plotAttributes['showCatName'] = self::getAttribute($chartDetail->dLbls->showCatName, 'val', 'string');
  433. }
  434. if (isset($chartDetail->dLbls->showSerName)) {
  435. $plotAttributes['showSerName'] = self::getAttribute($chartDetail->dLbls->showSerName, 'val', 'string');
  436. }
  437. if (isset($chartDetail->dLbls->showPercent)) {
  438. $plotAttributes['showPercent'] = self::getAttribute($chartDetail->dLbls->showPercent, 'val', 'string');
  439. }
  440. if (isset($chartDetail->dLbls->showBubbleSize)) {
  441. $plotAttributes['showBubbleSize'] = self::getAttribute($chartDetail->dLbls->showBubbleSize, 'val', 'string');
  442. }
  443. if (isset($chartDetail->dLbls->showLeaderLines)) {
  444. $plotAttributes['showLeaderLines'] = self::getAttribute($chartDetail->dLbls->showLeaderLines, 'val', 'string');
  445. }
  446. }
  447. return $plotAttributes;
  448. }
  449. /**
  450. * @param Layout $plotArea
  451. * @param mixed $plotAttributes
  452. */
  453. private static function setChartAttributes(Layout $plotArea, $plotAttributes)
  454. {
  455. foreach ($plotAttributes as $plotAttributeKey => $plotAttributeValue) {
  456. switch ($plotAttributeKey) {
  457. case 'showLegendKey':
  458. $plotArea->setShowLegendKey($plotAttributeValue);
  459. break;
  460. case 'showVal':
  461. $plotArea->setShowVal($plotAttributeValue);
  462. break;
  463. case 'showCatName':
  464. $plotArea->setShowCatName($plotAttributeValue);
  465. break;
  466. case 'showSerName':
  467. $plotArea->setShowSerName($plotAttributeValue);
  468. break;
  469. case 'showPercent':
  470. $plotArea->setShowPercent($plotAttributeValue);
  471. break;
  472. case 'showBubbleSize':
  473. $plotArea->setShowBubbleSize($plotAttributeValue);
  474. break;
  475. case 'showLeaderLines':
  476. $plotArea->setShowLeaderLines($plotAttributeValue);
  477. break;
  478. }
  479. }
  480. }
  481. }