← Back to Plugins
  • Apex Charts
  • Apex Charts
  • Apex Charts

Apex Charts

Plugin information

by Leandro C. Ferreira • 43 stars

Admin panel Widget Analytics

Apex Charts integration for Filament

Support

#apex-charts on Discord

Views

2170

License

MIT

Documentation

dashboard gif demo

Online Filament Project Example

Installation

You can install the package via composer:

composer require leandrocfe/filament-apex-charts

Optionally, you can publish the views using:

php artisan vendor:publish --tag="filament-apex-charts-views"

Usage

Start by creating a widget with the command:

php artisan make:filament-apex-charts BlogPostsChart

Available chart samples

You may choose:

You may also create an empty chart by selecting the Empty option.

This command will create the BlogPostsChart.php file in app\Filament\Widgets. Ex:

namespace App\Filament\Widgets;
 
use Leandrocfe\FilamentApexCharts\Widgets\ApexChartWidget;
 
class BlogPostsChart extends ApexChartWidget
{
/**
* Chart Id
*
* @var string
*/
protected static string $chartId = 'blogPostsChart';
 
/**
* Widget Title
*
* @var string|null
*/
protected static ?string $heading = 'BlogPostsChart';
 
/**
* Chart options (series, labels, types, size, animations...)
* https://apexcharts.com/docs/options
*
* @return array
*/
protected function getOptions(): array
{
return [
'chart' => [
'type' => 'bar',
'height' => 300,
],
'series' => [
[
'name' => 'BlogPostsChart',
'data' => [7, 4, 6, 10, 14, 7, 5, 9, 10, 15, 13, 18],
],
],
'xaxis' => [
'categories' => ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
'labels' => [
'style' => [
'colors' => '#9ca3af',
'fontWeight' => 600,
],
],
],
'yaxis' => [
'labels' => [
'style' => [
'colors' => '#9ca3af',
'fontWeight' => 600,
],
],
],
'colors' => ['#6366f1'],
];
}
}

Now, check out your new widget in the dashboard.

Available options

The getOptions() method is used to return an array of options based on Apex Charts Options. This structure is identical with the Apex Chart library, which Filament Apex Charts uses to render charts. You may use the Apex Chart documentation to fully understand the possibilities to return from getOptions().

Examples

Setting a widget title

You may set a widget title:

protected static ?string $heading = 'Blog Posts Chart';

Optionally, you can use The getHeading() method.

Setting a chart id

You may set a chart id:

protected static string $chartId = 'blogPostsChart';

Filtering chart data

You can set up chart filters to change the data shown on chart. Commonly, this is used to change the time period that chart data is rendered for.

To set a default filter value, set the $filter property:

public ?string $filter = 'today';

Then, define the getFilters() method to return an array of values and labels for your filter:

protected function getFilters(): ?array
{
return [
'today' => 'Today',
'week' => 'Last week',
'month' => 'Last month',
'year' => 'This year',
];
}

You can use the active filter value within your getOptions() method:

protected function getOptions(): array
{
$activeFilter = $this->filter;
 
// ...
}

Live updating (polling)

By default, chart widgets refresh their data every 5 seconds.

To customize this, you may override the $pollingInterval property on the class to a new interval:

protected static ?string $pollingInterval = '10s';

Alternatively, you may disable polling altogether:

protected static ?string $pollingInterval = null;