15 Commits
1.3.0 ... 1.5.2

Author SHA1 Message Date
Andrés Santibáñez
940109ef03 Fixed infinite growing charts 2020-11-09 10:53:42 -05:00
Andrés Santibáñez
0457a9a007 Updated CHANGELOG 2020-11-09 10:18:23 -05:00
Andrés Santibáñez
2c7317c3b8 Removed unused directives 2020-11-09 10:17:29 -05:00
Andrés Santibáñez
98df89eca4 Updated README 2020-11-09 08:49:16 -05:00
Andrés Santibáñez
de8ed5c844 Added release badge :) 2020-11-09 08:43:36 -05:00
Andrés Santibáñez
81b502fd10 Increased package version 2020-11-09 08:39:24 -05:00
Andrés Santibáñez
01176c001e Updated CHANGELOG and README 2020-11-09 08:38:15 -05:00
Andrés Santibáñez
8e9aed484e Added sparkline feature to charts 2020-11-09 08:29:43 -05:00
Andrés Santibáñez
f5b40ec73d Added LivewireCharts facade 2020-11-08 21:53:26 -05:00
Andrés Santibáñez
dbbbf8eca2 Updated README and CHANGELOG 2020-11-07 19:50:52 -05:00
Andrés Santibáñez
a002d2f041 Added support for multi-column stacked charts 2020-11-07 19:40:23 -05:00
Andrés Santibáñez
e11c5ca375 Improved code 2020-11-07 19:21:19 -05:00
Andrés Santibáñez
0af61a2997 Added support for multi column chart 2020-11-07 19:21:13 -05:00
Andrés Santibáñez
cb3e4180a1 Added support for custom categories in Area Chart 2020-11-06 23:59:34 -05:00
Andrés Santibáñez
1e7ac1bffb Added ability to add custom categories to xAxis 2020-11-06 23:50:51 -05:00
16 changed files with 385 additions and 47 deletions

View File

@@ -1,5 +1,24 @@
# Changelog
## 1.5.2 - 2020-11-09
- Fixed infinite growing charts
## 1.5.1 - 2020-11-09
- Removed unused Alpine directives
## 1.5.0 - 2020-11-09
- Added `LivewireCharts` facade to create any chart model
- Added `sparklined` Apex Chart feature to all charts (https://apexcharts.com/javascript-chart-demos/sparklines/basic/)
## 1.4.0 - 2020-11-07
- Added Multi Column Chart
- Added Stacked Multi Column Chart
- Added support for custom X Axis categories
## 1.3.0 - 2020-11-03
- Added Multi Line Chart

View File

@@ -1,3 +1,5 @@
[![GitHub release](https://img.shields.io/github/release/asantibanez/livewire-charts.svg)](https://github.com/asantibanez/livewire-charts/releases/)
![Livewire Charts](https://banners.beyondco.de/Livewire%20Charts.png?theme=light&packageName=asantibanez%2Flivewire-charts&pattern=graphPaper&style=style_1&description=Neat+Livewire+Charts+for+your+Laravel+projects&md=1&fontSize=100px&images=chart-square-bar)
## Preview
@@ -69,6 +71,19 @@ And that's it! You have a beautiful rendered chart in seconds. 👌
>Note: You can use these charts inside other Livewire components too. Just render them in your Blade template and you
are good to go. 👍
## LivewireCharts facade
Chart models can also be created using the `LivewireCharts` facade.
```php
LivewireCharts::lineChartModel();
LivewireCharts::multiLineChartModel();
LivewireCharts::columnChartModel();
LivewireCharts::multiColumnChartModel();
LivewireCharts::pieChartModel();
LivewireCharts::areaChartModel();
```
## Enabling Interactions
To enable click events, you must use the `with[XXX]ClickEvent($eventName)` method present in every model class and
@@ -138,6 +153,9 @@ for each type of chart.
| withoutDataLabels() | Disables data labels |
| withLegends() | Shows legends |
| withoutLegends() | Hides legends |
| setXAxisCategories(array $categories) | Enables custom categories for chart X Axis |
| sparklined() | Enables Apex Charts sparkline feature |
| setSparklineEnabled(boolean $isEnabled) | Enables/Disables Apex Charts sparkline feature |
#### LivewireLineChart
@@ -155,6 +173,9 @@ for each type of chart.
| Method | Description |
|--------|-------------|
| setOpacity(int $opacity) | Sets columns' opacity |
| multiColumn() | Sets chart to display multiple column series |
| singleColumn() | Sets chart to display a single column series |
| stacked() | Sets chart to display column series stacked |
| addColumn(string $title, double $value, string $color, array $extras = []) | Adds a column to the chart with the specified color. `$extras` is forwarded on click event |
| onColumnClickEventName(string $eventName) | Event Name that will be fired when a column of the chart is clicked |

View File

@@ -1,8 +1,7 @@
<div
class="w-full h-full"
style="width: 100%; height: 100%;"
x-data="{ ...areaChart() }"
x-init="drawChart(@this)"
x-on:draw-column-chart.window="drawChart(@this)"
>
<div wire:ignore x-ref="container"></div>
@@ -21,6 +20,12 @@
const dataLabels = component.get('areaChartModel.dataLabels') || {};
const onPointClickEventName = component.get('areaChartModel.onPointClickEventName')
const data = component.get('areaChartModel.data');
const sparkline = component.get('areaChartModel.sparkline');
const categories = component.get('areaChartModel.xAxis.categories').length > 0
? component.get('areaChartModel.xAxis.categories')
: data.map(item => item.title)
;
var options = {
series: [{
@@ -31,13 +36,13 @@
type: 'area',
height: '100%',
...sparkline,
zoom: { enabled: false },
toolbar: { show: false },
animations: {
enabled: animated,
},
animations: { enabled: animated },
events: {
markerClick: function(event, chartContext, { dataPointIndex }) {
@@ -66,7 +71,10 @@
labels: data.map(item => item.title),
xaxis: component.get('areaChartModel.xAxis') || {},
xaxis: {
labels: component.get('areaChartModel.xAxis.labels'),
categories: categories,
},
yaxis: component.get('areaChartModel.yAxis') || {},

View File

@@ -1,8 +1,7 @@
<div
class="w-full h-full"
style="width: 100%; height: 100%;"
x-data="{ ...columnChart() }"
x-init="drawChart(@this)"
x-on:draw-column-chart.window="drawChart(@this)"
>
<div wire:ignore x-ref="container"></div>
@@ -20,6 +19,7 @@
const onColumnClickEventName = component.get('columnChartModel.onColumnClickEventName')
const dataLabels = component.get('columnChartModel.dataLabels') || {};
const data = component.get('columnChartModel.data');
const sparkline = component.get('columnChartModel.sparkline');
const options = {
series: [{ data: data.map(item => item.value)}],
@@ -28,13 +28,11 @@
type: 'bar',
height: '100%',
toolbar: {
show: false
},
...sparkline,
animations: {
enabled: animated,
},
toolbar: { show: false },
animations: { enabled: animated },
events: {
dataPointSelection: function(event, chartContext, config) {

View File

@@ -1,5 +1,5 @@
<div
class="w-full h-full"
style="width: 100%; height: 100%;"
x-data="{ ...lineChart() }"
x-init="drawChart(@this)"
>
@@ -20,13 +20,16 @@
const dataLabels = component.get('lineChartModel.dataLabels') || {};
const data = component.get('lineChartModel.data');
const onPointClickEventName = component.get('lineChartModel.onPointClickEventName');
const sparkline = component.get('lineChartModel.sparkline');
const series = [{
name: title,
data: data.map(item => item.value),
}]
const categories = data.map(item => item.title)
const categories = component.get('lineChartModel.xAxis.categories').length > 0
? component.get('lineChartModel.xAxis.categories')
: data.map(item => item.title)
const options = {
series: series,
@@ -34,15 +37,15 @@
chart: {
type: 'line',
height: '100%',
zoom: {
enabled: false
},
toolbar: {
show: false
},
animations: {
enabled: animated,
},
...sparkline,
zoom: { enabled: false },
toolbar: { show: false },
animations: { enabled: animated },
events: {
markerClick: function(event, chartContext, { dataPointIndex }) {
if (!onPointClickEventName) {
@@ -65,7 +68,7 @@
},
xaxis: {
...component.get('lineChartModel.xAxis') || {},
labels: component.get('lineChartModel.xAxis.labels'),
categories: categories,
},

View File

@@ -0,0 +1,95 @@
<div
style="width: 100%; height: 100%;"
x-data="{ ...multiColumnChart() }"
x-init="drawChart(@this)"
>
<div wire:ignore x-ref="container"></div>
<script>
function multiColumnChart() {
return {
chart: null,
drawChart(component) {
if (this.chart) {
this.chart.destroy()
}
const stacked = component.get('columnChartModel.isStacked');
const animated = component.get('columnChartModel.animated');
const onColumnClickEventName = component.get('columnChartModel.onColumnClickEventName')
const dataLabels = component.get('columnChartModel.dataLabels');
const data = component.get('columnChartModel.data');
const sparkline = component.get('columnChartModel.sparkline');
const series = Object.keys(data)
.map(seriesName => ({
name: seriesName,
data: data[seriesName].map(item => item.value)
}))
const categories = component.get('columnChartModel.xAxis.categories').length > 0
? component.get('columnChartModel.xAxis.categories')
: data[series[0].name].map(item => item.title)
;
const options = {
series: series,
chart: {
type: 'bar',
height: '100%',
stacked: stacked,
...sparkline,
toolbar: { show: false },
animations: { enabled: animated },
events: {
dataPointSelection: function(event, chartContext, {seriesIndex, dataPointIndex}) {
if (!onColumnClickEventName) {
return
}
const column = data[series[seriesIndex].name][dataPointIndex]
component.call('onColumnClick', column)
},
}
},
legend: component.get('columnChartModel.legend'),
plotOptions: {
bar: {
horizontal: false,
columnWidth: '50%',
},
},
dataLabels: dataLabels,
xaxis: {
categories: categories,
},
yaxis: {
title: {
text: component.get('columnChartModel.title'),
}
},
fill: {
opacity: component.get('columnChartModel.opacity'),
},
};
this.chart = new ApexCharts(this.$refs.container, options);
this.chart.render();
}
}
}
</script>
</div>

View File

@@ -1,5 +1,5 @@
<div
class="w-full h-full"
style="width: 100%; height: 100%;"
x-data="{ ...multiLineChart() }"
x-init="drawChart(@this)"
>
@@ -20,6 +20,7 @@
const dataLabels = component.get('lineChartModel.dataLabels') || {};
const data = component.get('lineChartModel.data');
const onPointClickEventName = component.get('lineChartModel.onPointClickEventName');
const sparkline = component.get('lineChartModel.sparkline');
const series = Object.keys(data).map(key => {
return {
@@ -28,7 +29,9 @@
}
})
const categories = []
const categories = component.get('lineChartModel.xAxis.categories').length > 0
? component.get('lineChartModel.xAxis.categories')
: data[series[0].name].map(item => item.title)
const options = {
series: series,
@@ -36,23 +39,22 @@
chart: {
type: 'line',
height: '100%',
zoom: {
enabled: false
},
toolbar: {
show: false
},
animations: {
enabled: animated,
},
...sparkline,
zoom: { enabled: false },
toolbar: { show: false },
animations: { enabled: animated },
events: {
markerClick: function(event, chartContext, { seriesIndex, dataPointIndex }) {
if (!onPointClickEventName) {
return
}
const seriesName = Object.keys(data)[Object.keys(data).findIndex((el, index) => index === seriesIndex)]
const point = data[seriesName][dataPointIndex]
const point = data[series[seriesIndex].name][dataPointIndex]
component.call('onPointClick', point)
}
}
@@ -68,7 +70,7 @@
},
xaxis: {
...component.get('lineChartModel.xAxis') || {},
labels: component.get('lineChartModel.xAxis.labels'),
categories: categories,
},

View File

@@ -1,5 +1,5 @@
<div
class="w-full h-full"
style="width: 100%; height: 100%;"
x-data="{ ...pieChart() }"
x-init="drawChart(@this)"
>
@@ -20,6 +20,7 @@
const dataLabels = component.get('pieChartModel.dataLabels') || {}
const onSliceClickEventName = component.get('pieChartModel.onSliceClickEventName')
const data = component.get('pieChartModel.data')
const sparkline = component.get('pieChartModel.sparkline')
const options = {
series: data.map(item => item.value),
@@ -28,9 +29,9 @@
height: '100%',
type: 'pie',
animations: {
enabled: animated,
},
...sparkline,
animations: { enabled: animated },
events: {
dataPointSelection: function(event, chartContext, config) {

View File

@@ -31,6 +31,10 @@ class LivewireColumnChart extends Component
public function render()
{
if ($this->columnChartModel['isMultiColumn']) {
return view('livewire-charts::livewire-multi-column-chart');
}
return view('livewire-charts::livewire-column-chart');
}
}

View File

@@ -0,0 +1,27 @@
<?php
namespace Asantibanez\LivewireCharts\Facades;
use Asantibanez\LivewireCharts\Models\AreaChartModel;
use Asantibanez\LivewireCharts\Models\ColumnChartModel;
use Asantibanez\LivewireCharts\Models\LineChartModel;
use Asantibanez\LivewireCharts\Models\PieChartModel;
use Illuminate\Support\Facades\Facade;
/**
* Class LivewireCharts
* @package Asantibanez\LivewireCharts\Facades
* @method static LineChartModel lineChartModel()
* @method static LineChartModel multiLineChartModel()
* @method static ColumnChartModel columnChartModel()
* @method static ColumnChartModel multiColumnChartModel()
* @method static AreaChartModel areaChartModel()
* @method static PieChartModel pieChartModel()
*/
class LivewireCharts extends Facade
{
protected static function getFacadeAccessor()
{
return 'livewirecharts';
}
}

47
src/LivewireCharts.php Normal file
View File

@@ -0,0 +1,47 @@
<?php
namespace Asantibanez\LivewireCharts;
use Asantibanez\LivewireCharts\Models\AreaChartModel;
use Asantibanez\LivewireCharts\Models\ColumnChartModel;
use Asantibanez\LivewireCharts\Models\LineChartModel;
use Asantibanez\LivewireCharts\Models\PieChartModel;
class LivewireCharts
{
public function lineChartModel()
{
return (new LineChartModel)
->singleLine();
}
public function multiLineChartModel()
{
return (new LineChartModel)
->multiLine();
}
public function columnChartModel()
{
return (new ColumnChartModel)
->singleColumn();
}
public function multiColumnChartModel()
{
return (new ColumnChartModel)
->multiColumn();
}
public function areaChartModel()
{
return new AreaChartModel;
}
public function pieChartModel()
{
return new PieChartModel;
}
}

View File

@@ -35,6 +35,6 @@ class LivewireChartsServiceProvider extends ServiceProvider
*/
public function register()
{
//
$this->app->bind('livewirecharts', LivewireCharts::class);
}
}

View File

@@ -15,6 +15,7 @@ class BaseChartModel
use HasStroke;
use HasLegend;
use HasDataLabels;
use HasSparkline;
public function __construct()
{
@@ -24,6 +25,7 @@ class BaseChartModel
$this->initStroke();
$this->initLegend();
$this->initDataLabels();
$this->initSparkline();
}
public function reactiveKey()
@@ -39,7 +41,8 @@ class BaseChartModel
$this->axisToArray(),
$this->strokeToArray(),
$this->legendToArray(),
$this->dataLabelsToArray()
$this->dataLabelsToArray(),
$this->sparklineToArray()
);
}
@@ -51,5 +54,6 @@ class BaseChartModel
$this->strokeFromArray($array);
$this->legendFromArray($array);
$this->dataLabelsFromArray($array);
$this->sparklineFromArray($array);
}
}

View File

@@ -6,11 +6,17 @@ namespace Asantibanez\LivewireCharts\Models;
/**
* Class ColumnChartModel
* @package Asantibanez\LivewireCharts\Models
* @property boolean $isMultiColumn
* @property boolean $isStacked
*/
class ColumnChartModel extends BaseChartModel
{
public $opacity;
public $isMultiColumn;
public $isStacked;
public $onColumnClickEventName;
public $data;
@@ -23,9 +29,34 @@ class ColumnChartModel extends BaseChartModel
$this->opacity = 0.5;
$this->isMultiColumn = false;
$this->isStacked = false;
$this->data = collect();
}
public function multiColumn()
{
$this->isMultiColumn = true;
return $this;
}
public function singleColumn()
{
$this->isMultiColumn = false;
return $this;
}
public function stacked()
{
$this->isStacked = true;
return $this;
}
public function setOpacity($opacity)
{
$this->opacity = $opacity;
@@ -52,11 +83,29 @@ class ColumnChartModel extends BaseChartModel
return $this;
}
public function addSeriesColumn($seriesName, $title, $value, $extras = [])
{
$series = $this->data->get($seriesName, collect());
$series->push([
'seriesName' => $seriesName,
'title' => $title,
'value' => $value,
'extras' => $extras,
]);
$this->data->put($seriesName, $series);
return $this;
}
public function toArray()
{
return array_merge(parent::toArray(), [
'onColumnClickEventName' => $this->onColumnClickEventName,
'opacity' => $this->opacity,
'isMultiColumn' => $this->isMultiColumn,
'isStacked' => $this->isStacked,
'data' => $this->data->toArray(),
]);
}
@@ -69,6 +118,10 @@ class ColumnChartModel extends BaseChartModel
$this->opacity = data_get($array, 'opacity', 0.5);
$this->isMultiColumn = data_get($array, 'isMultiColumn', false);
$this->isStacked = data_get($array, 'isStacked', false);
$this->data = collect(data_get($array, 'data', []));
}
}

View File

@@ -10,7 +10,7 @@ trait HasAxis
private $yAxis;
public function initAxis()
protected function initAxis()
{
$this->xAxis = $this->defaultXAxis();
$this->yAxis = $this->defaultYAxis();
@@ -19,6 +19,7 @@ trait HasAxis
private function defaultXAxis()
{
return [
'categories' => [],
'labels' => [
'show' => true,
],
@@ -39,6 +40,13 @@ trait HasAxis
return $this;
}
public function setXAxisCategories($categories = [])
{
data_set($this->xAxis, 'categories', $categories);
return $this;
}
public function setYAxisVisible($visible)
{
data_set($this->yAxis, 'show', $visible);

View File

@@ -0,0 +1,48 @@
<?php
namespace Asantibanez\LivewireCharts\Models;
trait HasSparkline
{
private $sparkline;
public function setSparklineEnabled($isEnabled)
{
data_set($this->sparkline, 'sparkline.enabled', $isEnabled);
return $this;
}
public function sparklined()
{
return $this->setSparklineEnabled(true);
}
protected function initSparkline()
{
$this->sparkline = $this->defaultSparkline();
}
private function defaultSparkline()
{
return [
'sparkline' => [
'enabled' => false,
],
];
}
protected function sparklineFromArray($array)
{
$this->sparkline = data_get($array, 'sparkline', $this->defaultSparkline());
}
protected function sparklineToArray()
{
return [
'sparkline' => $this->sparkline,
];
}
}