Feat: adds bar overlap property for 2d bar charts

Author: mindline-analytics

docs/usage/shapes/chart.md

@@ -331,6 +331,20 @@ $barChart = new Bar();
 $barChart->setGapWidthPercent(250);
 ```
 
+#### Overlap
+
+You can define the bar overlap within bars or columns clusters. It is defined in percent.
+The default value is 100% for stacked and 0% for grouped bar charts. The value must be defined between -100 and 100.
+
+When defining the bar grouping type, the default overlap values will be set. Any changes to the overlap must be made after setting the bar grouping type through `setBarGrouping`.
+
+``` php
+<?php
+
+$barChart = new Bar();
+$barChart->setOverlapWidthPercent(-10);
+```
+
 #### Stacking
 
 You can stack multiples series in a same chart. After adding multiples series, you can define the bar grouping with `setBarGrouping` method of AbstractTypeBar.
@@ -418,4 +432,3 @@ $chart->setIsSmooth(false);
 // Get status of smooth line
 $chart->isSmooth();
 ```
-

src/PhpPresentation/Shape/Chart/Type/AbstractTypeBar.php

@@ -53,6 +53,14 @@ class AbstractTypeBar extends AbstractType
      */
     protected $gapWidthPercent = 150;
 
+    /**
+     * Overlap within bar or columns clusters. Value between 100 and -100 percent.
+     * For stacked bar charts, the default overlap will be 100, for grouped bar charts 0.
+     *
+     * @var int
+     */
+    protected $overlapWidthPercent = 0;
+
     /**
      * Set bar orientation.
      *
@@ -87,6 +95,11 @@ public function getBarDirection()
     public function setBarGrouping($value = self::GROUPING_CLUSTERED)
     {
         $this->barGrouping = $value;
+        $this->overlapWidthPercent = 0;
+        
+        if( $value === self::GROUPING_STACKED || $value === self::GROUPING_PERCENTSTACKED ) {
+            $this->overlapWidthPercent = 100;
+        }
 
         return $this;
     }
@@ -127,6 +140,32 @@ public function setGapWidthPercent($gapWidthPercent)
         return $this;
     }
 
+    /**
+     * @return int
+     */
+    public function getOverlapWidthPercent()
+    {
+        return $this->overlapWidthPercent;
+    }
+
+    /**
+     * @param int $overlapWidthPercent
+     *
+     * @return $this
+     */
+    public function setOverlapWidthPercent($overlapWidthPercent)
+    {
+        if ($overlapWidthPercent < -100) {
+            $overlapWidthPercent = -100;
+        }
+        if ($overlapWidthPercent > 100) {
+            $overlapWidthPercent = 100;
+        }
+        $this->overlapWidthPercent = $overlapWidthPercent;
+
+        return $this;
+    }
+
     /**
      * Get hash code.
      *

src/PhpPresentation/Writer/PowerPoint2007/PptCharts.php

@@ -985,13 +985,8 @@ protected function writeTypeBar(XMLWriter $objWriter, Bar $subject, bool $includ
         $objWriter->endElement();
 
         // c:overlap
-        $barGrouping = $subject->getBarGrouping();
         $objWriter->startElement('c:overlap');
-        if (Bar::GROUPING_CLUSTERED === $barGrouping) {
-            $objWriter->writeAttribute('val', '0');
-        } elseif (Bar::GROUPING_STACKED === $barGrouping || Bar::GROUPING_PERCENTSTACKED === $barGrouping) {
-            $objWriter->writeAttribute('val', '100');
-        }
+        $objWriter->writeAttribute('val', $subject->getOverlapWidthPercent());
         $objWriter->endElement();
 
         // c:axId

tests/PhpPresentation/Tests/Shape/Chart/Type/BarTest.php

@@ -90,6 +90,32 @@ public function testGapWidthPercent(): void
         $this->assertEquals(500, $object->getGapWidthPercent());
     }
 
+    public function testOverlapWidthPercentDefaults(): void
+    {
+        $object = new Bar();
+        $this->assertEquals(0, $object->getOverlapWidthPercent());
+        
+        $object->setBarGrouping(Bar::GROUPING_STACKED);
+        $this->assertEquals(100, $object->getOverlapWidthPercent());
+        $object->setBarGrouping(Bar::GROUPING_CLUSTERED);
+        $this->assertEquals(0, $object->getOverlapWidthPercent());
+        $object->setBarGrouping(Bar::GROUPING_PERCENTSTACKED);
+        $this->assertEquals(100, $object->getOverlapWidthPercent());
+    }
+
+    public function testOverlapWidthPercent(): void
+    {
+        $value = mt_rand(-100, 100);
+        $object = new Bar();
+        $this->assertEquals(0, $object->getOverlapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar', $object->setOverlapWidthPercent($value));
+        $this->assertEquals($value, $object->getOverlapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar', $object->setOverlapWidthPercent(101));
+        $this->assertEquals(100, $object->getOverlapWidthPercent());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Shape\\Chart\\Type\\Bar', $object->setOverlapWidthPercent(-101));
+        $this->assertEquals(-100, $object->getOverlapWidthPercent());
+    }
+
     public function testHashCode(): void
     {
         $oSeries = new Series();

tests/PhpPresentation/Tests/Writer/PowerPoint2007/PptChartsTest.php

@@ -582,6 +582,8 @@ public function testTypeBar(): void
         $oShape->setResizeProportional(false)->setHeight(550)->setWidth(700)->setOffsetX(120)->setOffsetY(80);
         $oBar = new Bar();
         $oBar->setGapWidthPercent($valueGapWidthPercent);
+        $valueOverlapWidthPercent = -10;
+        $oBar->setOverlapWidthPercent($valueOverlapWidthPercent);
         $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));
@@ -603,6 +605,8 @@ public function testTypeBar(): void
         $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);
+        $element = '/c:chartSpace/c:chart/c:plotArea/c:barChart/c:overlap';
+        $this->assertZipXmlAttributeEquals('ppt/charts/' . $oShape->getIndexedFilename(), $element, 'val', $valueOverlapWidthPercent);
 
         $this->assertIsSchemaECMA376Valid();
     }