README

A Laravel charting data visualization library built on top of strucura/visualizations. Define your chart series as typed datasets backed by raw SQL expressions, expose them as API endpoints, and let your front-end render them with any chart library.

Installation

composer require strucura/charts

Concepts

Creating a Chart

Use the Artisan generator to scaffold a new chart:

php artisan make:chart RevenueChart

This creates app/Charts/RevenueChart.php:

use Strucura\Charts\Abstracts\Chart;
use Strucura\Charts\Labels\Label;
use Strucura\Charts\Datasets\Bar;

class RevenueChart extends Chart
{
    public function getLabel(): Label
    {
        return Label::make('order_date', 'date');
    }

    public function getDatasets(): Collection
    {
        return collect([
            Bar::make('SUM(total)', 'revenue')->header('Revenue'),
            Bar::make('SUM(refunds)', 'refunds')->header('Refunds'),
        ]);
    }

    public function getQuery(): Builder
    {
        return DB::table('orders')
            ->groupBy('order_date');
    }
}

Registering Routes

Register chart routes in your routes/api.php (or any route file) using the chart route macro:

Route::chart(RevenueChart::class);

This registers two endpoints automatically:

The route path and name are derived from the class name. RevenueChart → /charts/revenues.

API

Schema endpoint

POST /charts/revenues/schema

{
  "chart_key": "charts.revenues",
  "label": { "field": "date", "header": "date", "meta": {} },
  "datasets": [
    { "field": "revenue", "header": "Revenue", "type": "bar", "meta": {} },
    { "field": "refunds", "header": "Refunds", "type": "bar", "meta": {} }
  ]
}

Data endpoint

POST /charts/revenues/data

Optional request body:

{
  "filter_sets": [
    {
      "filter_set_operator": "and",
      "filters": [
        { "field": "date", "value": "2024-01-01", "filter_operator": "gte" }
      ]
    }
  ],
  "sorts": [
    { "field": "date", "sort_operator": "asc" }
  ]
}

Response is an array of objects, one per row from the query:

[
  { "date": "2024-01-01", "revenue": 12000, "refunds": 300 },
  { "date": "2024-01-02", "revenue": 14500, "refunds": 150 }
]

Available Dataset Types

All dataset types share the inherited Visualizable API:

Bar::make('SUM(total)', 'revenue')
    ->header('Total Revenue')      // display label
    ->meta('color', '#4ade80');    // arbitrary front-end config

Authorization

Implement getPermissionName() on your chart class to gate both endpoints via Laravel's Gate::authorize():

public function getPermissionName(): string
{
    return 'view-revenue-chart';
}

Customizing Routes

Override getRoutePrefix(), getRouteName(), or getRoutePath() to take full control of the generated routes:

public function getRoutePrefix(): string
{
    return 'reporting';
}

Testing

composer test

Changelog

Please see CHANGELOG for information on recent changes.

Credits

• Andrew Leach
• All Contributors

License

The MIT License (MIT). Please see License File for more information.