JqPlotPlugin < TWiki

TWiki Web>JqPlotPlugin (2024-03-02, TWikiAdminUser) (raw view)

---+!! !JqPlotPlugin
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/JqPlotPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/JqPlotPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.

One line description, required for extensions repository catalog.
   * Set SHORTDESCRIPTION = Add line, bar and pie charts to TWiki topics using jqPlot !JavaScript library
-->
<sticky>
<div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div>
</sticky>
%SHORTDESCRIPTION%

---++ Usage

<verbatim>
%JQPLOT{"canvasTextRenderer,canvasAxisLabelRenderer"}%
<div id='chart1' style='height:280px; width: 500px;'></div>
<script>
$.jqplot ('chart1', [[3,7,9,1,4,6,8,2,5]]);
</script>
</verbatim>

<!--
The following would look better if the real thing and the screenshot are
displayed side-by-side.
But on IE 7, a jqplot generated graph is not displayed in a table cell.
-->
__Resulting chart (if plugin is installed and enabled):__
%JQPLOT{"canvasTextRenderer,canvasAxisLabelRenderer"}%
<div id='chart1' style='height:280px; width: 500px;'></div>
<script>
$.jqplot ('chart1', [[3,7,9,1,4,6,8,2,5]]);
</script>

__Simulated (screenshot):__
<div>
%ATTACHURL%/chart1.png
</sticky>

More examples are found in the [[http://www.jqplot.com/deploy/dist/examples/][official jqPlot website]].

---++ Description

[[http://www.jqplot.com/][jqPlot]] is a "pure javascript plotting" library, and this TWiki plugin bundles the package with easy setup using =%<nop>JQPLOT%= tag.

Since jqPlot depends on the jQuery !JavaScript library, JQueryPlugin must be installed for JqPlotPlugin to work.

When a =%<nop>JQPLOT%= tag is present, the necessary !JavaScript and CSS references are added to the =&lt;head&gt;= of the page. The =%<nop>JQPLOT%= tag itself is expanded into an empty string. Even if the tag happens to be used multiple times, the required references are added only once.

In order to use jqPlot plugins (for bar charts, pie charts, axis labels, etc.), the plugin names should be added to the =%<nop>JQPLOT%= tag.

<verbatim>
%JQPLOT{"barRenderer, pieRenderer, categoryAxisRenderer"}%
 or
%JQPLOT{"barRenderer"}%
%JQPLOT{"pieRenderer"}%
%JQPLOT{"categoryAxisRenderer"}%
</verbatim>

The above will add the =&lt;script&gt;= tags to the =&lt;head&gt;= as below:

<verbatim>
<script type="text/javascript" src=".../plugins/jqplot.barRenderer.min.js"></script>
<script type="text/javascript" src=".../plugins/jqplot.pieRenderer.min.js"></script>
<script type="text/javascript" src=".../plugins/jqplot.categoryAxisRenderer.min.js"></script>
</verbatim>

All the common references such as =jquery.jqplot.min.js= (which would be added by the empty =%<nop>JQPLOT%=) are also added automatically.

---++ Installation Instructions

__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

   * For an __automated installation__, run the [[%SCRIPTURL{configure}%][configure]] script and follow "Find More Extensions" in the in the __Extensions__ section.
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.

   * Or, follow these __manual installation__ steps:
      * Download the ZIP file from the Plugins home (see below).
      * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
        | *File:* | *Description:* |
        | ==data/TWiki/JqPlotPllugin.txt== | Plugin topic |
        | ==data/TWiki/VarJQPLOT.txt== | JQPLOT variable documentation topic |
        | ==lib/TWiki/Plugins/JqPlotPlugin.pm== | Plugin Perl module |
        | ==pub/TWiki/JqPlotPlugin/*.png== | Image files |
        | ==pub/TWiki/JqPlotPlugin/jquery.jqplot.*== | jqPlot library package |
      * Set the ownership of the extracted directories and files to the webserver user.
      * Install the dependencies.

   * Plugin __configuration and testing__:
      * Run the [[%SCRIPTURL{configure}%][configure]] script and enable the plugin in the __Plugins__ section.
      * Test if the installation was successful using the example above.

---++ Plugin Info

Many thanks to the following sponsors for supporting this work:
   * Morgan Stanley

|  Plugin Author: | TWiki:Main.MahiroAndo |
|  Copyright: | &copy; 2012-2013 TWiki:Main.MahiroAndo %BR% &copy; 2012-2013 TWiki:TWiki.TWikiContributor |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Plugin Version: | 2013-03-06 jquery.jqplot.1.0.7r1224 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2013-03-06: | Fixed Fast CGI/mod_perl unfriendliness, upgraded to jquery.jqplot.1.0.7r1224 |
|  2012-11-14: | Initial release with jquery.jqplot.1.0.4r1121 |
|  Dependencies: | JQueryPlugin |
|  Plugin Home: | http://twiki.org/cgi-bin/view/Plugins/JqPlotPlugin |
|  Feedback: | http://twiki.org/cgi-bin/view/Plugins/JqPlotPluginDev |
|  Appraisal: | http://twiki.org/cgi-bin/view/Plugins/JqPlotPluginAppraisal |

__Related Topics:__ %SYSTEMWEB%.VarJQPLOT, %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
png	chart1.png	r1	manage	20.6 K	2013-03-06 - 02:22	TWikiAdminUser	Saved by install script
bz2	jquery.jqplot.1.0.7r1224.tar.bz2	r1	manage	1117.1 K	2013-03-06 - 02:22	TWikiAdminUser	Saved by install script

Topic revision: r2 - 2024-03-02 - TWikiAdminUser

TWiki

Webs
Blog
TWiki
ZMobile

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.JqPlotPlugin.