brendt/php-sparkline

Generate sparkline SVGs in PHP

2.0.0 2024-06-11 11:33 UTC

Requires

• php: ^8.1
• ramsey/uuid: ^4.6

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.13
• larapack/dd: ^1.1
• phpunit/phpunit: ^9.5

MIT

• Brent Roose

• brendt
• php-sparkline

README

PHP-Sparkline generates GitHub style sparkline graphs. Read this guide to know how to use it.

Installation

You can install the package via composer:

composer require brendt/php-sparkline

Usage

$sparkLine = new SparkLine(1, 2, 5, 10, 2);

$total = $sparkLine->getTotal();

$svg = $sparkLine->make();

To construct a sparkline, you'll have to pass in an array of values.

Customization

You can pick any amount of colors and the sparkline will automatically generate a gradient from them:

$sparkLine = (new SparkLine($days))->withColors('#4285F4', '#31ACF2', '#2BC9F4');

You can configure the stroke width:

$sparkLine = (new SparkLine($days))->withStrokeWidth(4);

As well as the dimensions (in pixels):

$sparkLine = SparkLine::new($days)->withDimensions(width: 500, height: 100);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Brent Roose
• All Contributors

License

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