You are here

Home » API reference » Flot 8

README.txt in Flot 8

Same filename in this branch
  1. 8 README.txt
  2. 8 flot_spider/README.txt
  3. 8 flot_examples/README.txt
  4. 8 flot_axislabels/README.txt
  5. 8 flot_JUMlib/README.txt
Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


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

The Flot module provides an API and views integration for using the flot
graphing library. It is designed to make it simple to add flot graphs or charts,
it supports line, bar and pie charts.

The Flot object contains series data, and chart options. The module's element
scans these to determine which javascript libraries to include. The plot can be
rendered using an included bare-bones template, or the developer can create
their own for more complex logic and layouts. The flot_examples module
demonstrates basic and more advanced techniques.

 * For a full description of the module visit:
   https://www.drupal.org/project/flot or
   http://code.google.com/p/flot/

 * For a Flot usage example visit:
   http://drupal.org/node/386484

 * To submit bug reports and feature suggestions, or to track changes visit:
   https://www.drupal.org/project/issues/flot


REQUIREMENTS
------------

 * [Flot JS library](https://github.com/flot/flot)


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

Install the Flot module as you would normally install a contributed Drupal
module. Visit https://www.drupal.org/node/1897420 for further information.


CONFIGURATION
-------------

    1. Extract the [Flot JS library](https://github.com/flot/flot) to
       `/DrupalRoot/libraries/flot`
       (i.e. `/DrupalRoot/libraries/flot/jquery.flot.pie.js`)
    2. Navigate to Admin>Extend to install Flot and any relevant Flot
       sub-modules (Timeseries, Spider Chart, etc.)


Developers can use this module in either of two ways, using the default
render element, or creating a new render element.

Views Formatters:
The Drupal 8 module also contains two views formatters. These can be used to
render views as a pie chart, bar chart, or time-series line or scatter plot
without the need to type a single line of code.

Plugins:
Flot has been extended by many developers through the creation of other plugins.
These plugins can be easily enabled by creating a simple wrapper around the
existing JavaScript code and creating a new Element. The flot_spider module
demonstrates this process.


MAINTAINERS
-----------

 * Beakerboy - https://www.drupal.org/u/beakerboy
 * Jelle Sebreghts (Jelle_S) - https://www.drupal.org/u/jelle_s
 * Peter Droogmans (attiks) - https://www.drupal.org/u/attiks
 * yhahn - https://www.drupal.org/user/264833
 * Jeff Miccolis (jmiccolis) - https://www.drupal.org/user/31731

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. The Flot module provides an API and views integration for using the flot

  15. graphing library. It is designed to make it simple to add flot graphs or charts,

  16. it supports line, bar and pie charts.

  17. 

  18. The Flot object contains series data, and chart options. The module's element

  19. scans these to determine which javascript libraries to include. The plot can be

  20. rendered using an included bare-bones template, or the developer can create

  21. their own for more complex logic and layouts. The flot_examples module

  22. demonstrates basic and more advanced techniques.

  23. 

  24.  * For a full description of the module visit:

  25.    https://www.drupal.org/project/flot or

  26.    http://code.google.com/p/flot/

  27. 

  28.  * For a Flot usage example visit:

  29.    http://drupal.org/node/386484

  30. 

  31.  * To submit bug reports and feature suggestions, or to track changes visit:

  32.    https://www.drupal.org/project/issues/flot

  33. 

  34. 

  35. REQUIREMENTS

  36. ------------

  37. 

  38.  * [Flot JS library](https://github.com/flot/flot)

  39. 

  40. 

  41. INSTALLATION

  42. ------------

  43. 

  44. Install the Flot module as you would normally install a contributed Drupal

  45. module. Visit https://www.drupal.org/node/1897420 for further information.

  46. 

  47. 

  48. CONFIGURATION

  49. -------------

  50. 

  51.     1. Extract the [Flot JS library](https://github.com/flot/flot) to

  52.        `/DrupalRoot/libraries/flot`

  53.        (i.e. `/DrupalRoot/libraries/flot/jquery.flot.pie.js`)

  54.     2. Navigate to Admin>Extend to install Flot and any relevant Flot

  55.        sub-modules (Timeseries, Spider Chart, etc.)

  56. 

  57. 

  58. Developers can use this module in either of two ways, using the default

  59. render element, or creating a new render element.

  60. 

  61. Views Formatters:

  62. The Drupal 8 module also contains two views formatters. These can be used to

  63. render views as a pie chart, bar chart, or time-series line or scatter plot

  64. without the need to type a single line of code.

  65. 

  66. Plugins:

  67. Flot has been extended by many developers through the creation of other plugins.

  68. These plugins can be easily enabled by creating a simple wrapper around the

  69. existing JavaScript code and creating a new Element. The flot_spider module

  70. demonstrates this process.

  71. 

  72. 

  73. MAINTAINERS

  74. -----------

  75. 

  76.  * Beakerboy - https://www.drupal.org/u/beakerboy

  77.  * Jelle Sebreghts (Jelle_S) - https://www.drupal.org/u/jelle_s

  78.  * Peter Droogmans (attiks) - https://www.drupal.org/u/attiks

  79.  * yhahn - https://www.drupal.org/user/264833

  80.  * Jeff Miccolis (jmiccolis) - https://www.drupal.org/user/31731