Open Flash Chart Helper: draw charts the Cake way

by joaquin_win
Open Flash Chart ([url]http://teethgrinder.co.uk/open-flash-chart/[/url]) is a nice solution to drawing charts from data on your applications. This helper makes using Open Flash Chart with CakePHP simple.
Note. spanish translation of this tutorial can be found here: http://aikon.com.ve/open-flash-chart-helper-graficos-al-estilo-cake/

Prerequisites

To make use of this helper, first you need to download Open Flash Chart zip file from http://teethgrinder.co.uk/open-flash-chart/download.php
Inside it there are two files needed to use this helper:

- open-flash-chart.swf place this file in your [app]/webroot/ directory
- php-ofc-library/open-flash-chart.php place this file in your [app]/vendors directory.

The Helper File:

To get the latest version of the helper fetch it from the subversion repo:
svn co http://svn2.assembla.com/svn/cakeopenflashchart/trunk/flash_chart.php
If you don't use svn you can fetch it directly from that url.

Usage

Now, to use this helper do as in any other helper:

<?php
    
var $helpers = array('FlashChart');
?>

The examples below are all placed on a view file: [app]/views/pages/charts.ctp (so you must modify PagesController to use the Helper) and generate random data (but using data from database is equally easy).

Example 1 - Bar Graphs

View Template:

<?php
// Sets height and width
$flashChart->begin(400250);
// Title
$flashChart->title('Example 1 - Bars: Hits per Day');
// Configure Grid style and legends
$flashChart->configureGrid(
    array(
        
'x_axis' => array(
            
'step' => 1,
            
'legend' => 'Day'
        
),
        
'y_axis' => array(
            
'legend' => '#Hits',
        )
    )
);
// Prepare some random data (10 points)
$random_hits = array();
for (
$i=0$i 10$i++) { 
    
$random_hits[] = rand(10,100);
}
// Register each data set with its information.
$data = array(
    
'Hits' => array(
        
'color' => '#afe342',
        
'font_size' => 11,
        
'data' => $random_hits,
        
'graph_style' => 'bar',
    )
);
$flashChart->setData($data);

// Set Ranges in the chart
$flashChart->setRange('y'0100);
$flashChart->setRange('x'010);

// Show the graph
echo $flashChart->render();
?>

This view generates a simple bar graph with the random data generated in a loop. To generate another graph in the same view you must allways call FlashChartHelper::begin to reset all data.

Tip: change 'graph_style' => 'bar' to one of the following to see all types of bar graphs that are available:
  • 'graph_style' => 'bar_sketch'
  • 'graph_style' => 'bar_glass'
  • 'graph_style' => 'bar_filled'
  • 'graph_style' => 'bar_3D'
  • 'graph_style' => 'bar_fade'

Example 2 - Line Graphs

To draw lines instead of bars, the only change needed in the example above is 'graph_style' => 'bar' to one of the following:
  • 'graph_style' => 'line'
  • 'graph_style' => 'line_hollow'
  • 'graph_style' => 'line_dot'

View Template:

<?php
// Sets height and width
$flashChart->begin(400250);
// Title
$flashChart->title('Example 2 - Lines: Hits per Day');
// Configure Grid style and legends
$flashChart->configureGrid(
    array(
        
'x_axis' => array(
            
'step' => 1,
            
'legend' => 'Day'
        
),
        
'y_axis' => array(
            
'legend' => '#Hits',
        )
    )
);
// Prepare some random data (10 points)
$random_hits = array();
for (
$i=0$i 10$i++) { 
    
$random_hits[] = rand(10,100);
}
// Register each data set with its information.
$data = array(
    
'Hits' => array(
        
'color' => '#00aa42',
        
'font_size' => 11,
        
'data' => $random_hits,
        
'graph_style' => 'lines',
    )
);
$flashChart->setData($data);

// Set Ranges in the chart
$flashChart->setRange('y'0100);
$flashChart->setRange('x'010);

// Show the graph
echo $flashChart->render();
?>

Example 3 - Scatter (Points) Graphs

This type of graph uses a different syntax to define the data. It requires data to be set as points (pairs x,y), here is the example:

View Template:

<?php
// Sets height and width
$flashChart->begin(400250);
// Title
$flashChart->title('Example 3 - Scatter: Some Random Points');
// Configure Grid style and legends
$flashChart->configureGrid(
    array(
        
'x_axis' => array(
            
'step' => 1,
            
'legend' => 'Day'
        
),
        
'y_axis' => array(
            
'legend' => '#Hits',
        )
    )
);
// Prepare some random data (10 points)
$random_points = array();
for (
$i=0$i 10$i++) { 
    
// Each point is represented as a pair (x,y)
    
$random_points[] = array('x' => $i'y' => rand(0,100));
}
// Register each data set with its information.
$data = array(
    
'Random Points' => array(
        
'color' => '#00aa42',
        
'font_size' => 11,
        
'data' => $random_points,
        
'graph_style' => 'scatter'
    
)
);
$flashChart->setData($data);

// Set Ranges in the chart
$flashChart->setRange('y'0100);
$flashChart->setRange('x'010);

// Show the graph
echo $flashChart->render();
?>

Example 4 - Pie Graphs

This type of graph also uses a different syntax, here is the example:

View Template:

<?php
$flashChart
->begin(400250);
$flashChart->title('Example 4 - Pie Chart: My imaginary Browser Stats');
$browser_data = array(
    
'Firefox' => array(
        
'value' => 30
    
),
    
'Opera' => array(
        
'value' => 7
    
),
    
'IE' => array(
        
'value' => 38
    
),
    
'Other' => array(
        
'value' => 25
    
)
);
$flashChart->pie($browser_data);

echo 
$flashChart->render();
?>

Tip: Flash Chart Helper automatically selects colors for each element in data if you don't set them explicitly.

Example 5 - Mixed Graphs

Open Flash Chart allows to draw various data sets inside one graph, you can mix bars with lines and scatter, here are some examples that extend the first example.

View Template:

<?php
// Sets height and width
$flashChart->begin(400250);
// Title
$flashChart->title('Example 5 - Mixed: Hits per Day vs. # Visits');
// Configure Grid style and legends
$flashChart->configureGrid(
    array(
        
'x_axis' => array(
            
'step' => 1,
            
'legend' => 'Day'
        
),
        
'y_axis' => array(
            
'legend' => '#Hits',
        )
    )
);
// Prepare some random data (10 points)
$visits = array();
$random_hits2 = array();
for (
$i=0$i 10$i++) { 
    
$visits[] = rand(10,50);
    
$random_hits2[] = rand(50,100);
}
// Register each data set with its information.
$data = array(
    
'Hits' => array(
        
'color' => '#afe342',
        
'font_size' => 11,
        
'data' => $random_hits2,
        
'graph_style' => 'line_dot',
    ),
    
'Visits' => array(
        
'color' => '#324aef',
        
'font_size' => 11,
        
'data' => $visits,
        
'graph_style' => 'bar',
    )
);
$flashChart->setData($data);

// Set Ranges in the chart
$flashChart->setRange('y'0100);
$flashChart->setRange('x'010);

// Show the graph
echo $flashChart->render();
?>

Results

The results from this examples can be found at http://aikon.com.ve/flashchart/

What's Missing

At this point there are two types of charts that Open Flash Chart allows that the Helper doesn't implement:

Some enhancements could be done:
  • Some higher level function to encapsulate many of the lines used in the examples can be written.
  • Automatically choosing the ranges of the axis.

If you find anything missing, please report it: http://trac2.assembla.com/cakeopenflashchart/newticket

Report

More on Helpers

Advertising

Comments

  • rthakurdas posted on 08/29/10 12:05:20 PM
    i am not able to get the flash_chart.php from this link svn co http://svn2.assembla.com/svn/cakeopenflashchart/trunk/flash_chart.php where will i get the helper file??
  • guru12 posted on 05/29/09 06:20:34 AM
    hi,

    i follwed all the steps stated above....
    when i open the url....am getting this....

    &title=Example+4+-+Pie+Chart%3A+My+imaginary+Browser+Stats,{font-size:14px;color:#333333;}& &x_legend=X,12,#666666& &x_label_style=9,#666666,0,#000000& &x_axis_steps=1& &y_legend=Y,12,#666666& &y_label_style=9,#666666& &y_ticks=5,10,5& &line=3,#87421F& &x_min=0& &x_max=0& &y_min=0& &y_max=0& &bg_colour=#ffffff& &x_axis_colour=#666666& &x_grid_colour=#dddddd& &y_axis_colour=#666666& &y_grid_colour=#dddddd& &pie=60,#505050,{font-size:12px;color:#333333;}& &values=30,7,38,25& &pie_labels=Firefox,Opera,IE,Other& &colours=#b663c8,#b6632d,#1b632d,#1bc72d& &links=& &tool_tip=%23x_label%23%3Cbr%3E%23val%23%25&


    am not able to see the chart....

    please help ASAP

    Thanks,
    Guru
  • memons posted on 04/11/09 07:11:28 PM
    Hi there,
    I am getting following error? would you kindly guide me, what am i missing?
    Fatal error: Class 'graph' not found in C:\wamp\www\testchart3\views\helpers\flash_chart.php on line 56
    Thanks
  • FrankTheTank posted on 02/24/09 11:15:18 AM
    This thing is great. I haven't gotten deep into it's coding to look for this yet, but is there a way to regulate the y-axis steps like the x-axis? I'm working on a chart that only uses integer values, but the y-axis often displays values with a decimal place.

    Otherwise, it works like a dream. Thanks again!
  • OJBizzle posted on 01/08/09 06:46:33 AM
    Hey, I realise this version is out of date, but I could not get the newer version working ... plus the site I am adding to has been built in cake 1.1.

    Basically if I have 1 pie chart (the only graph type I want) on a page it works beautifully in all browsers. However, if I try and render a second pie chart on the same page IE and safari kick up a fuss and won't load. Firefox, google chrome and opera all work as expected (hoped).

    I am using this to render a chart in one of my views:

    $flashChart->begin(400, 250);
    $flashChart->title('Rewards By Year');
    $flashChart->pie($year_data);
    echo $flashChart->render();


    and then further down the page this:

    $flashChart->begin(400, 250);
    $flashChart->title('Rewards By Subject');
    $flashChart->pie($subject_data);
    echo $flashChart->render();


    If i comment out from $flashChart->pie($subject_data); IE loads fine, if I have that line or the render line in I get the following error...

    'Internet Explorer cannot open the Internet site.

    Operation aborted.'

    I have been trying and trying to fix this but truth be told I don't know enough about javascript or any of this stuff to try and resolve the issue. Please can someone give me some help so I can move on and get on with other work for the site?

    Thank you very much in advance.

    OJBizzle
  • alkemann posted on 12/09/08 02:38:56 AM
    Anand this is the wrong article :)

    And I solved your issue in the google code issue you submitted (missing echo).
  • Andyy posted on 12/08/08 01:25:46 AM
    Hi

    I m new to open flash chart.I copied all the files to the location as stated above.Now I m getting error "Class 'graph' not found in /opt/lampp/htdocs/reportgenerator/app/views/helpers/flash_chart.php on line 56".
    Any solution would be appreciated
  • alkemann posted on 10/29/08 04:38:00 AM
    A remake for version 2 can be found here :

    http://bakery.cakephp.org/articles/view/flashcharthelper-version-3
    Note that the new helper is not backward compatible, but hopefully it is even easier to use, so the upgrade work should not be too hard.
    • Andyy posted on 12/08/08 11:51:08 PM
      Hi
      I have put all the files in the directory as u told in the article.
      I m getting this error.Please brief any solution.Any help would be appreciated.
      "
      Open Flash Chart

      JSON Parse Error [Syntax Error] Error at character 0, line 1:

      0:
      "


      A remake for version 2 can be found here :

      http://bakery.cakephp.org/articles/view/flashcharthelper-version-3
      Note that the new helper is not backward compatible, but hopefully it is even easier to use, so the upgrade work should not be too hard.
      • FrankTheTank posted on 02/24/09 11:17:17 AM
        I had this same problem - got about 50 errors, starting with JSON. Turned out that I grabbed the new 2.x version of OFC. Get a copy of 1.9.7 and you'll be good to go, or upgrade your helper to the new version that works with OFC 2:
        http://bakery.cakephp.org/articles/view/flashcharthelper-version-3
        Frank


        Hi
        I have put all the files in the directory as u told in the article.
        I m getting this error.Please brief any solution.Any help would be appreciated.
        "
        Open Flash Chart

        JSON Parse Error [Syntax Error] Error at character 0, line 1:

        0:
        "


        A remake for version 2 can be found here :

        http://bakery.cakephp.org/articles/view/flashcharthelper-version-3
        Note that the new helper is not backward compatible, but hopefully it is even easier to use, so the upgrade work should not be too hard.
  • kanten posted on 10/22/08 12:38:30 PM
    Hi,

    Would it be easy to update the helper to used with version 2 of Open Flash Chart (http://teethgrinder.co.uk/open-flash-chart-2/)?


    /Anders
  • chiacy posted on 07/24/08 02:04:55 PM
    I am using a Mac, the sample does not seems to work with Safari although this page http://aikon.com.ve/flashchart/ works well.

    from Safari's inspect element debugger, it shows the following error:

    ReferenceError: Can't find variable: SWFObject

    after this:


    var so = new SWFObject("/open-flash-chart.swf", "ofc", "780", "390", "9", "#FFFFFF");

    swfobject.js is placed in webroot/js folder, and apache virtual server set cake as home directory.

    However, it works with Firefox 3 on my Mac.

    Anyone can help?

    Rgds,
    chiacy
  • alkemann posted on 05/19/08 12:38:05 PM
    In an effort to simplify the process of using this helper, I created this behavior:

    http://bakery.cakephp.org/articles/view/chartable-behavior
  • patrick posted on 05/10/08 10:19:46 AM
    I had problems testing your examples until I added the file js/swfobject.js of the Open Flash Chart zip file to [app]/webroot/js/ directory.
    Now the chart shows up :)
  • pointlessjon posted on 05/09/08 04:45:07 PM
    radical!
login to post a comment.