Merge pull request #364 from Progi1984/issue358

#358 : PowerPoint2007 Writer : Implement gap width in Bar(3D) Charts
PHPOffice · May 21, 2017 · 4a0adf8 · 4a0adf8
2 parents 44d670e + 2bd0670
commit 4a0adf8
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,9 @@
 - PowerPoint2007 Writer : Write percentage values with a trailing percent sign instead of formatted as 1000th of a percent to comply with the standard - @k42b3 GH-307
 
 ### Features
-- PowerPoint2007 Writer : Implement XSD validation test case according to the ECMA/ISO standard - @k42b3 GH-307
+- PowerPoint2007 Writer : Implemented XSD validation test case according to the ECMA/ISO standard - @k42b3 GH-307
 - PowerPoint2007 Writer : Implement visibility for axis - @kw-pr @Progi1984 GH-356 
+- PowerPoint2007 Writer : Implement gap width in Bar(3D) Charts - @Progi1984 GH-358
 
 ## 0.8.0 - 2017-04-03
 

diff --git a/docs/shapes_chart.rst b/docs/shapes_chart.rst
@@ -186,6 +186,17 @@ TODO
 Bar & Bar3D
 ^^^^^^^^^^^
 
+Gap Width
+"""""""""
+
+You can define the gap width between bar or columns clusters. It is defined in percent.
+The default value is 150%. The value must be defined between 0 and 500.
+
+.. code-block:: php
+
+    $oBarChart = new Bar();
+    $oBarChart->setGapWidthPercent(250);
+
 Stacking
 """"""""
 

diff --git a/samples/Sample_05_Chart.php b/samples/Sample_05_Chart.php
@@ -82,6 +82,7 @@ function fnSlide_Bar(PhpPresentation $objPHPPresentation) {
     // Create a bar chart (that should be inserted in a shape)
     echo date('H:i:s') . ' Create a bar chart (that should be inserted in a chart shape)'.EOL;
     $barChart = new Bar();
+    $barChart->setGapWidthPercent(158);
     $series1 = new Series('2009', $series1Data);
     $series1->setShowSeriesName(true);
     $series1->getFill()->setFillType(Fill::FILL_SOLID)->setStartColor(new Color('FF4F81BD'));

diff --git a/src/PhpPresentation/Shape/Chart/Type/AbstractTypeBar.php b/src/PhpPresentation/Shape/Chart/Type/AbstractTypeBar.php
@@ -48,6 +48,14 @@ class AbstractTypeBar extends AbstractType
     protected $barGrouping = self::GROUPING_CLUSTERED;
 
 
+    /**
+     * Space between bar or columns clusters
+     *
+     * @var int
+     */
+    protected $gapWidthPercent = 150;
+
+
     /**
      * Set bar orientation
      *
@@ -91,6 +99,30 @@ public function getBarGrouping()
     {
         return $this->barGrouping;
     }
+
+    /**
+     * @return int
+     */
+    public function getGapWidthPercent()
+    {
+        return $this->gapWidthPercent;
+    }
+
+    /**
+     * @param int $gapWidthPercent
+     * @return $this
+     */
+    public function setGapWidthPercent($gapWidthPercent)
+    {
+        if ($gapWidthPercent < 0) {
+            $gapWidthPercent = 0;
+        }
+        if ($gapWidthPercent > 500) {
+            $gapWidthPercent = 500;
+        }
+        $this->gapWidthPercent = $gapWidthPercent;
+        return $this;
+    }
 
     /**
      * Get hash code

diff --git a/src/PhpPresentation/Writer/PowerPoint2007/PptCharts.php b/src/PhpPresentation/Writer/PowerPoint2007/PptCharts.php
@@ -972,7 +972,7 @@ protected function writeTypeBar(XMLWriter $objWriter, Bar $subject, $includeShee
 
         // c:gapWidth
         $objWriter->startElement('c:gapWidth');
-        $objWriter->writeAttribute('val', '75');
+        $objWriter->writeAttribute('val', $subject->getGapWidthPercent());
         $objWriter->endElement();
 
         // c:shape
@@ -1174,7 +1174,7 @@ protected function writeTypeBar3D(XMLWriter $objWriter, Bar3D $subject, $include
 
         // c:gapWidth
         $objWriter->startElement('c:gapWidth');
-        $objWriter->writeAttribute('val', '75');
+        $objWriter->writeAttribute('val', $subject->getGapWidthPercent());
         $objWriter->endElement();
 
         // c:shape

diff --git a/tests/PhpPresentation/Tests/Shape/Chart/Type/Bar3DTest.php b/tests/PhpPresentation/Tests/Shape/Chart/Type/Bar3DTest.php
@@ -75,6 +75,19 @@ public function testBarGrouping()
         $this->assertEquals(Bar3D::GROUPING_PERCENTSTACKED, $object->getBarGrouping());
     }
 
+    public function testGapWidthPercent()
+    {
+        $value = rand(0, 500);
+        $object = new Bar3D();
+        $this->assertEquals(150, $object->getGapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar3D', $object->setGapWidthPercent($value));
+        $this->assertEquals($value, $object->getGapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar3D', $object->setGapWidthPercent(-1));
+        $this->assertEquals(0, $object->getGapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar3D', $object->setGapWidthPercent(501));
+        $this->assertEquals(500, $object->getGapWidthPercent());
+    }
+
     public function testHashCode()
     {
         $oSeries = new Series();

diff --git a/tests/PhpPresentation/Tests/Shape/Chart/Type/BarTest.php b/tests/PhpPresentation/Tests/Shape/Chart/Type/BarTest.php
@@ -75,6 +75,19 @@ public function testBarGrouping()
         $this->assertEquals(Bar::GROUPING_PERCENTSTACKED, $object->getBarGrouping());
     }
 
+    public function testGapWidthPercent()
+    {
+        $value = rand(0, 500);
+        $object = new Bar();
+        $this->assertEquals(150, $object->getGapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar', $object->setGapWidthPercent($value));
+        $this->assertEquals($value, $object->getGapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar', $object->setGapWidthPercent(-1));
+        $this->assertEquals(0, $object->getGapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar', $object->setGapWidthPercent(501));
+        $this->assertEquals(500, $object->getGapWidthPercent());
+    }
+
     public function testHashCode()
     {
         $oSeries = new Series();

diff --git a/tests/PhpPresentation/Tests/Writer/PowerPoint2007/PptChartsTest.php b/tests/PhpPresentation/Tests/Writer/PowerPoint2007/PptChartsTest.php
@@ -348,10 +348,12 @@ public function testTypeAxisUnit()
 
     public function testTypeBar()
     {
+        $valueGapWidthPercent = rand(0, 500);
         $oSlide = $this->oPresentation->getActiveSlide();
         $oShape = $oSlide->createChartShape();
         $oShape->setResizeProportional(false)->setHeight(550)->setWidth(700)->setOffsetX(120)->setOffsetY(80);
         $oBar = new Bar();
+        $oBar->setGapWidthPercent($valueGapWidthPercent);
         $oSeries = new Series('Downloads', $this->seriesData);
         $oSeries->getDataPointFill(0)->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_BLUE));
         $oSeries->getDataPointFill(1)->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_DARKBLUE));
@@ -371,14 +373,18 @@ public function testTypeBar()
         $this->assertZipXmlElementExists('ppt/charts/' . $oShape->getIndexedFilename(), $element);
         $element = '/c:chartSpace/c:chart/c:plotArea/c:barChart/c:ser/c:tx/c:v';
         $this->assertZipXmlElementEquals('ppt/charts/' . $oShape->getIndexedFilename(), $element, $oSeries->getTitle());
+        $element = '/c:chartSpace/c:chart/c:plotArea/c:barChart/c:gapWidth';
+        $this->assertZipXmlAttributeEquals('ppt/charts/' . $oShape->getIndexedFilename(), $element, 'val', $valueGapWidthPercent);
     }
 
     public function testTypeBar3D()
     {
+        $valueGapWidthPercent = rand(0, 500);
         $oSlide = $this->oPresentation->getActiveSlide();
         $oShape = $oSlide->createChartShape();
         $oShape->setResizeProportional(false)->setHeight(550)->setWidth(700)->setOffsetX(120)->setOffsetY(80);
         $oBar3D = new Bar3D();
+        $oBar3D->setGapWidthPercent($valueGapWidthPercent);
         $oSeries = new Series('Downloads', $this->seriesData);
         $oSeries->getDataPointFill(0)->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_BLUE));
         $oSeries->getDataPointFill(1)->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_DARKBLUE));
@@ -398,6 +404,8 @@ public function testTypeBar3D()
         $this->assertZipXmlElementExists('ppt/charts/' . $oShape->getIndexedFilename(), $element);
         $element = '/c:chartSpace/c:chart/c:plotArea/c:bar3DChart/c:ser/c:tx/c:v';
         $this->assertZipXmlElementEquals('ppt/charts/' . $oShape->getIndexedFilename(), $element, $oSeries->getTitle());
+        $element = '/c:chartSpace/c:chart/c:plotArea/c:bar3DChart/c:gapWidth';
+        $this->assertZipXmlAttributeEquals('ppt/charts/' . $oShape->getIndexedFilename(), $element, 'val', $valueGapWidthPercent);
     }
 
     public function testTypeBar3DSubScript()