Skip to content

Latest commit

 

History

History
102 lines (80 loc) · 2.95 KB

usage.md

File metadata and controls

102 lines (80 loc) · 2.95 KB
Raw

Usage

Basic Line Chart

In your controller ...

use HighchartsBundle\Highcharts\Highchart;

public function chartAction()
{
    $series = [
        [
            "name" => "Data Serie Name",
            "data" => [1,2,4,5,6,3,8]
        ]
    ];

    $chart = new Highchart();
    $chart->chart->renderTo('container');  // The #id of the div where to render the chart
    $chart->title->text('Chart Title');
    $chart->xAxis->title(['text' => "Horizontal axis title"]);
    $chart->yAxis->title(['text' => "Vertical axis title"]);
    $chart->series($series);

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

In your template ...

<!-- Load jQuery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.js"></script>
<!-- Load highcharts -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highcharts/11.4.1/highcharts.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highcharts/11.4.1/modules/exporting.min.js"></script>
<script>
    {{ chart(chart) }}
</script>

<div id="container" style="min-width: 400px; height: 400px; margin: 0 auto"></div>

Use highcharts with mootools

If you'd like to use mootools instead of jquery to render your charts, load the mootools adapter to use as the second argument of the twig extension like this

<!-- Load MooTools -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mootools/1.6.0/mootools-core.js"></script>
<!-- Load highcharts -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highcharts/11.4.1/highcharts.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highcharts/11.4.1/modules/exporting.min.js"></script>
<script>
    {{ chart(chart, 'mootools') }}
</script>

<div id="container" style="min-width: 400px; height: 400px; margin: 0 auto"></div>

Use highcharts without a jquery or mootools wrapper

It is also possible to render your highcharts code without a jquery or mootools wrapper. This is useful when you want to control how and when the chart is loaded or when integrating with existing code.

<!-- Load highcharts -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highcharts/11.4.1/highcharts.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highcharts/11.4.1/modules/exporting.min.js"></script>
<script>
    myLib.chartLoad(function(data){
        {{ chart(chart, false) }}
    });
</script>

<div id="container" style="min-width: 400px; height: 400px; margin: 0 auto"></div>

Use a Javascript anonymous function

There are several use cases where you need to define a javascript function, let's see how to use one for a tooltip formatter

// ...
$expression = AbstractChart::createExpression("function() {
    return 'The value for <b>' + this.x + '</b> is <b>' + this.y + '</b>';
}");
$chart = new Highchart();
$chart->tooltip->formatter($expression);
// ...

See also