[[PageOutline(2-5,Contents,pullout)]]

= JQPlot Chart Macro

== Description

This macro adds [http://www.jqplot.com/index.php jqPlot] based charts to Trac pages:

[[Image(gauge.png)]]
[[Image(line.png)]]

jqPlot is a plotting and charting plugin for the jQuery Javascript framework and is dual licensed under GPL and MIT.

== Bugs/Feature Requests

Existing bugs and feature requests for JqChartMacro are 
[report:9?COMPONENT=JqChartMacro here].

If you have any issues, create a 
[/newticket?component=JqChartMacro new ticket].

[[TicketQuery(component=JqChartMacro&group=type,format=progress)]]

== Download

Download the zipped source from [export:jqchartmacro here].

== Source

You can check out JqChartMacro from [/svn/jqchartmacro here] using Subversion, or [source:jqchartmacro browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

Make sure that jqplotchart is enabled in your `trac.ini` file:

{{{#!ini
[components]
jqplotchart.* = enabled
}}}

== Example

This creates a gauge counting the number of rows returned in report number 10:

{{{
{{{
#!JQChart
  "type": "MeterGauge",
  "report_id": 10,
  "options" : {
    "seriesDefaults": {
      "rendererOptions": {
        "label": "# bugs",
        "intervals": [4, 8, 12]
      }
    }
  }
}}}
}}}

This creates a line chart with one series per ticket type. The x axis is the time the ticket was created, and the y axis is a 'cooked' number for demonstration only (the ticket id times 10). Notice that the sql query returns the ticket id. This will make each point in the chart clickable. When you click on a point, you will be sent to the ticket corresponding to that point:

{{{
{{{
#!JQChart
  "width": 400,
  "height": 250,
  "query": "select type, time, id * 10, id from ticket order by time",
  "options" : {
    "title": "Creation date of each ticket, by type"
  },
  "series_column": "type"
}}}
}}}


The following creates a pie chart showing the number of tickets for each status. Label and grid are hidden.
{{{
{{{
#!JQChart
  "type": "Pie",
  "width": 400,
  "height": 250,
  "query": "SELECT status, count(status) AS number FROM ticket GROUP BY status",
  "options": {
      "title": "Ticket status",
      "axes": {
          "xaxis": {
              "drawMajorGridlines": false,
              "numberTicks": 0
          }
      },
      "grid": {
          "borderWidth":1.0,
          "shadow": false
      },
      "seriesDefaults":{
          "rendererOptions": {
              "showDataLabels": true,
              "sliceMargin": 8,
              "padding": 25,
              "dataLabels": "value"
          }
      },
      "legend": {
          "show": true,
          "placement": "inside",
          "location": "w",
          "marginTop": "15px"
      }
  }
}}}
}}}
The options element is the jqPlot options parameter. See the [http://www.jqplot.com/index.php jqPlot website] for more information.

== Recent Changes

[[ChangeLog(jqchartmacro, 3)]]

== Author/Contributors

'''Author:''' [wiki:gpablo] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''