Add Chart Axis Option textRotation (#2940)

Fix #2705. Add to Axis class, Reader Xlsx Chart, and Writer Xlsx Chart. Add feature to an existing 32* sample, to an existing 33* sample, and a formal unit test.
PHPOffice · Jul 17, 2022 · 051598e · 051598e
1 parent 4bf4278
commit 051598e
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 1 deletion.
diff --git a/samples/Chart/33_Chart_create_scatter2.php b/samples/Chart/33_Chart_create_scatter2.php
@@ -124,6 +124,7 @@
 $xAxis = new Axis();
 //$xAxis->setAxisNumberProperties(Properties::FORMAT_CODE_DATE );
 $xAxis->setAxisNumberProperties(Properties::FORMAT_CODE_DATE_ISO8601, true);
+$xAxis->setAxisOption('textRotation', '45');
 
 $yAxis = new Axis();
 $yAxis->setLineStyleProperties(

diff --git a/samples/templates/32readwriteScatterChart8.xlsx b/samples/templates/32readwriteScatterChart8.xlsx
diff --git a/src/PhpSpreadsheet/Chart/Axis.php b/src/PhpSpreadsheet/Chart/Axis.php
@@ -60,6 +60,7 @@ public function __construct()
         'axis_labels' => self::AXIS_LABELS_NEXT_TO,
         'horizontal_crosses' => self::HORIZONTAL_CROSSES_AUTOZERO,
         'horizontal_crosses_value' => null,
+        'textRotation' => null,
     ];
 
     /**
@@ -136,7 +137,8 @@ public function setAxisOptionsProperties(
         ?string $minimum = null,
         ?string $maximum = null,
         ?string $majorUnit = null,
-        ?string $minorUnit = null
+        ?string $minorUnit = null,
+        ?string $textRotation = null
     ): void {
         $this->axisOptions['axis_labels'] = $axisLabels;
         $this->setAxisOption('horizontal_crosses_value', $horizontalCrossesValue);
@@ -148,6 +150,7 @@ public function setAxisOptionsProperties(
         $this->setAxisOption('maximum', $maximum);
         $this->setAxisOption('major_unit', $majorUnit);
         $this->setAxisOption('minor_unit', $minorUnit);
+        $this->setAxisOption('textRotation', $textRotation);
     }
 
     /**

diff --git a/src/PhpSpreadsheet/Reader/Xlsx/Chart.php b/src/PhpSpreadsheet/Reader/Xlsx/Chart.php
@@ -1279,5 +1279,15 @@ private function setAxisProperties(SimpleXMLElement $chartDetail, ?Axis $whichAx
         if (isset($chartDetail->minorUnit)) {
             $whichAxis->setAxisOption('minor_unit', (string) self::getAttribute($chartDetail->minorUnit, 'val', 'string'));
         }
+        if (isset($chartDetail->txPr)) {
+            $children = $chartDetail->txPr->children($this->aNamespace);
+            if (isset($children->bodyPr)) {
+                /** @var string */
+                $textRotation = self::getAttribute($children->bodyPr, 'rot', 'string');
+                if (is_numeric($textRotation)) {
+                    $whichAxis->setAxisOption('textRotation', (string) Properties::xmlToAngle($textRotation));
+                }
+            }
+        }
     }
 }
diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Chart.php b/src/PhpSpreadsheet/Writer/Xlsx/Chart.php
@@ -573,6 +573,23 @@ private function writeCategoryAxis(XMLWriter $objWriter, ?Title $xAxisLabel, $id
             $objWriter->endElement();
         }
 
+        $textRotation = $yAxis->getAxisOptionsProperty('textRotation');
+        if (is_numeric($textRotation)) {
+            $objWriter->startElement('c:txPr');
+            $objWriter->startElement('a:bodyPr');
+            $objWriter->writeAttribute('rot', Properties::angleToXml((float) $textRotation));
+            $objWriter->endElement(); // a:bodyPr
+            $objWriter->startElement('a:lstStyle');
+            $objWriter->endElement(); // a:lstStyle
+            $objWriter->startElement('a:p');
+            $objWriter->startElement('a:pPr');
+            $objWriter->startElement('a:defRPr');
+            $objWriter->endElement(); // a:defRPr
+            $objWriter->endElement(); // a:pPr
+            $objWriter->endElement(); // a:p
+            $objWriter->endElement(); // c:txPr
+        }
+
         $objWriter->startElement('c:spPr');
         $this->writeColor($objWriter, $yAxis->getFillColorObject());
         $this->writeEffects($objWriter, $yAxis);
@@ -748,6 +765,23 @@ private function writeValueAxis(XMLWriter $objWriter, ?Title $yAxisLabel, $group
             $objWriter->endElement();
         }
 
+        $textRotation = $xAxis->getAxisOptionsProperty('textRotation');
+        if (is_numeric($textRotation)) {
+            $objWriter->startElement('c:txPr');
+            $objWriter->startElement('a:bodyPr');
+            $objWriter->writeAttribute('rot', Properties::angleToXml((float) $textRotation));
+            $objWriter->endElement(); // a:bodyPr
+            $objWriter->startElement('a:lstStyle');
+            $objWriter->endElement(); // a:lstStyle
+            $objWriter->startElement('a:p');
+            $objWriter->startElement('a:pPr');
+            $objWriter->startElement('a:defRPr');
+            $objWriter->endElement(); // a:defRPr
+            $objWriter->endElement(); // a:pPr
+            $objWriter->endElement(); // a:p
+            $objWriter->endElement(); // c:txPr
+        }
+
         $objWriter->startElement('c:spPr');
         $this->writeColor($objWriter, $xAxis->getFillColorObject());
         $this->writeLineStyles($objWriter, $xAxis);

diff --git a/tests/PhpSpreadsheetTests/Chart/Charts32ScatterTest.php b/tests/PhpSpreadsheetTests/Chart/Charts32ScatterTest.php
@@ -391,6 +391,9 @@ public function testScatter8(): void
         $chart = $charts[0];
         self::assertNotNull($chart);
 
+        $xAxis = $chart->getChartAxisX();
+        self::assertEquals(45, $xAxis->getAxisOptionsProperty('textRotation'));
+
         $plotArea = $chart->getPlotArea();
         self::assertNotNull($plotArea);
         $plotSeries = $plotArea->getPlotGroup();