Changes between Version 3 and Version 4 of TracYetAnotherChartMacro

Timestamp:

May 13, 2018, 7:51:47 PM (6 years ago)

Author:

Theodor Norup

Comment:

--

TracYetAnotherChartMacro

@@ -38 +38 @@
 
 {{{
-[[yachart(id=first; title=Action statuses; query=SELECT status, COUNT(status) FROM ticket where type = 'Action' GROUP BY status)]]
+[[yachart(id=first; title=Action statuses; query=SELECT status, COUNT(status) FROM ticket WHERE type = 'Action' GROUP BY status)]]
 }}}
 
@@ -50 +50 @@
 
 {{{#!ini
-id         = dom-name # The name of the HTML DOM carrying the chart. Mandatory. Must be unique for each macro call on a wiki page
-title      = title-text # The headline shown above the chart. Default: blank.
+id         = dom-name     # The name of the HTML DOM carrying the chart. Mandatory. Must be unique for each macro call on a wiki page
+title      = title-text   # The headline shown above the chart. Default: blank.
 chart_type = bar|line|pie # Optional; default: bar
-query      = sql-query # Mandatory
-width      = pixel-width # Optional; default: 600 pixels
-height     = pixel-height # optional: default: 400 pixels
+query      = sql-query    # Mandatory
+width      = pixel-width  # Optional; default: 600 pixels
+height     = pixel-height # Optional: default: 400 pixels
 }}}
+
+The query must return two columns. In `line` and `bar` charts, the first column will be used as x-axis data and the second column as y-axis data. In `pie` charts, the columns will be used as labels and values, respectively.
 
 In the query, the macro will replace the string `$USER` with the id of the user logged in. This can be used to display "my tickets":
 
 [[Image(newplot(2).png, width=300)]]
+
+WikiProcessor syntax is supported which may make queries easier to read (and write):
+{{{
+   {{{#!yachart
+   id=something;
+   title=something else;
+   query=SELECT 
+            status, 
+            COUNT(status) 
+         FROM ticket 
+         WHERE type = 'Action' 
+         GROUP BY status;
+   }}}
+}}}
 
 == Recent Changes