Merge pull request #3 from Practically/v1.0

V1.0

Author: AdeAttwood

src/Dataset.php

@@ -96,6 +96,22 @@ class Dataset extends \yii\base\Component
         'rgba(255, 159, 64, 1)'
     ];
 
+    /**
+     * The fill for the dataset
+     *
+     * @see https://www.chartjs.org/docs/latest/charts/area.html#filling-modes
+     *
+     * @var mixed
+     */
+    public $fill = null;
+
+    /**
+     * Label for the dataset
+     *
+     * @var string
+     */
+    public $label = '';
+
     /**
      * Executes the query and populates the data with the result of the query
      *
@@ -146,6 +162,14 @@ public function getDataset()
             $dataset['borderWidth'] = $this->borderWidth;
         }
 
+        if ($this->fill !== null) {
+            $dataset['fill'] = $this->fill;
+        }
+
+        if (strlen($this->label) > 0) {
+            $dataset['label'] = $this->label;
+        }
+
         return $dataset;
     }
 
@@ -200,6 +224,8 @@ public function addBarColors($dataset, $attribute, $label)
 
                 $i += count($this->$attribute);
             }
+        } elseif (is_string($this->$attribute)) {
+            $dataset[$label] = $this->$attribute;
         }
 
         return $dataset;

tests/DatasetTest.php

@@ -96,4 +96,54 @@ public function testColorCount(): void
             count($dataset['backgroundColor'])
         );
     }
+
+    /**
+     * Test that you can use string as colors for line charts
+     *
+     * @return void
+     */
+    public function testColorsAsStrings(): void
+    {
+        $this->dataset->backgroundColors = 'red';
+        $this->dataset->borderColors = 'blue';
+        $dataset = $this->dataset->getDataset();
+
+        $this->assertEquals('red', $dataset['backgroundColor']);
+        $this->assertEquals('blue', $dataset['borderColor']);
+    }
+
+    /**
+     * Tests you can set the fill property of the dataset
+     *
+     * @return void
+     */
+    public function testDatasetFill(): void
+    {
+        $this->assertArrayNotHasKey(
+            'fill',
+            $this->dataset->getDataset()
+        );
+
+        $this->dataset->fill = false;
+        $this->assertFalse($this->dataset->getDataset()['fill']);
+    }
+
+    /**
+     * Test you can add a label to the dataset
+     *
+     * @return void
+     */
+    public function testAddingLabelsToDatasets(): void
+    {
+        $this->assertArrayNotHasKey(
+            'label',
+            $this->dataset->getDataset()
+        );
+
+        $this->dataset->label = 'My New Label';
+        $this->assertEquals(
+            'My New Label',
+            $this->dataset->getDataset()['label']
+        );
+    }
 }