You are here

Home » API reference » Flot 6

README.txt in Flot 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

* Introduction 
* Installation 
* API


INTRODUCTION 
------------

Authors: 
* Jeff Miccolis (jmiccolis)

Support was provided by Development Seed and the New America Foundation.

Flot is a javascript graphing library written using the jquery that we all know
and love. This module is designed to make it dead-simple to push data into a
flot graph.


INSTALLATION
------------

1. Copy the flot module directory to your sites/SITENAME/modules directory.

2. Download flot from http://code.google.com/p/flot/

3. Extract it as a sub-directory called 'flot' in the flot module folder. For
example:

 /sites/all/modules/flot/flot/

4. Enable the module at Administer >> Site building >> Modules.


API
---

The main API function is a theme function - theme_flot_graph(). It is designed
to mimic the main $.plot() function that flot provides. Think of it as a php
wrapper. It takes the same arguments in the same order as $.plot and returns
the placeholder element that flot will use to make it's graph. Please refer to
API.txt included in the flot package for more details on how to make flot work.

To get started quickly try the following example:

<?php

$d1 = new flotData(array(array(0, 1), array(4, 8), array(8, 5)));
$d2 = new flotData(array(array(0, 8), array(3, 5), array(8, 0.5)));
print theme('flot_graph', array(), array($d1, $d2));

?>

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5. * Introduction 

  6. * Installation 

  7. * API

  8. 

  9. 

  10. INTRODUCTION 

  11. ------------

  12. 

  13. Authors: 

  14. * Jeff Miccolis (jmiccolis)

  15. 

  16. Support was provided by Development Seed and the New America Foundation.

  17. 

  18. Flot is a javascript graphing library written using the jquery that we all know

  19. and love. This module is designed to make it dead-simple to push data into a

  20. flot graph.

  21. 

  22. 

  23. INSTALLATION

  24. ------------

  25. 

  26. 1. Copy the flot module directory to your sites/SITENAME/modules directory.

  27. 

  28. 2. Download flot from http://code.google.com/p/flot/

  29. 

  30. 3. Extract it as a sub-directory called 'flot' in the flot module folder. For

  31. example:

  32. 

  33.  /sites/all/modules/flot/flot/

  34. 

  35. 4. Enable the module at Administer >> Site building >> Modules.

  36. 

  37. 

  38. API

  39. ---

  40. 

  41. The main API function is a theme function - theme_flot_graph(). It is designed

  42. to mimic the main $.plot() function that flot provides. Think of it as a php

  43. wrapper. It takes the same arguments in the same order as $.plot and returns

  44. the placeholder element that flot will use to make it's graph. Please refer to

  45. API.txt included in the flot package for more details on how to make flot work.

  46. 

  47. To get started quickly try the following example:

  48. 

  50. 

  51. $d1 = new flotData(array(array(0, 1), array(4, 8), array(8, 5)));

  52. $d2 = new flotData(array(array(0, 8), array(3, 5), array(8, 0.5)));

  53. print theme('flot_graph', array(), array($d1, $d2));

  54. 

  55. ?>