README

IMPORTANT NOTICE: This package is no longer maintained.

highcharts-bundle eases the use of highcharts to display rich graphs and charts in your Symfony 2 application by providing Twig extensions and PHP objects to do the heavy lifting. The bundle include the excellent JS library Highcharts.

Dry out your chart code by writing it all in PHP !

Includes:

Highcharts 5.14.0

If you like this package, pay me a beer (or a coffee)

Compatibility

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this package:

$ composer require webeweb/highcharts-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

    public function registerBundles() {
        $bundles = [
            // ...
            new WBW\Bundle\HighchartsBundle\HighchartsBundle(),
        ];

        // ...

        return $bundles;
    }

Once the bundle is added then do:

$ php bin/console assets:install

Usage

In your controller ...

    // Prepare the data.
    $data = [["name" => "Female", "y" => 25 ], ["name" => "Male", "y" => 25], ["name" => "Unknown", "y" => 50]];

    // Initialize the series.
    $series = [["colorByPoint" => true, "data" => $data, "name" => "Gender distribution"]];

    // Initialize the chart.
    $chart = new HighchartsChart;
    $chart->newChart()->setType("pie");
    $chart->newPlotOptions()->newPie()
        ->setAllowPointSelect(true)
        ->setCursor("pointer")
        ->setShowInLegend(true)
        ->newDataLabels()->setEnabled(true);
    $chart->setSeries($series);
    $chart->newTitle()->setText("Gender distribution");
    $chart->newTooltip()->setPointFormat("{series.name}: <b>{point.percentage:.1f}%</b>");

    return $this->render('::your_template.html.twig', [
        'chart' => $chart
    ]);

In your template ...

    <div id="Container"></div>
    {{ highchartsScript('highcharts') }}
    {{ highchartsScript('modules/exporting') }}
    {{ highchartsChart('Container', chart) }}

Testing

To test the package, is better to clone this repository on your computer. Open a command console and execute the following commands to download the latest stable version of this package:

$ git clone https://github.com/webeweb/highcharts-bundle.git
$ cd highcharts-bundle
$ composer install

Once all required libraries are installed then do:

$ vendor/bin/phpunit

License

highcharts-bundle is released under the MIT License. See the bundled LICENSE file for details.

Please note that the Highcharts JS library is not free for commercial use, see their FAQ for more details on what constitutes a non-commercial project or their product page for details on pricing.

Donate

If you like this work, please consider donating at

webeweb / highcharts-bundle

Maintainers

Details