Add charts documentation

Signed-off-by: Michal Čihař <michal@cihar.com>

1 files changed, 141 insertions, 0 deletions

diff --git a/doc/charts.rst b/doc/charts.rst
new file mode 100644
index 0000000000..ae4f2c612e
--- /dev/null
+++ b/doc/charts.rst
@@ -0,0 +1,141 @@
+Charts
+======
+
+.. versionadded:: 3.4.0
+
+Since phpMyAdmin version 3.4.0, you can easily generate charts from a SQL query
+by clicking the "Display chart" link in the "Query results operations" area.
+
+.. image:: images/query_result_operations.png
+
+A window layer "Display chart" is shown in which you can customize the chart with the following options.
+
+-   Chart type: Allows you chose the type of the chart. Supported types are bar charts, column charts, line charts, spline charts, area charts, pie charts and timeline charts (only the chart types applicable for current series selection are offered).
+-   X-axis: Allows to chose the field for the main axis.
+-   Series: Allows to chose series for the chart. You can chose multiple series.
+-   Title: Allows specifying a title for the chart which is displayed above the chart.
+-   X-axis and Y-axis labels: Allows specifying labels for axes.
+-   Start row and number of rows: Allows generating charts only for a specified number of rows of the results set.
+
+.. image:: images/chart.png
+
+Chart implementation
+--------------------
+
+Charts in phpMyAdmin are drawn using `jqPlot <http://www.jqplot.com/>`_ jQuery library.
+
+Examples
+--------
+
+Pie chart
++++++++++
+
+Query results for a simple pie chart can be generated with:
+
+.. code-block:: sql
+
+    SELECT 'Food' AS 'expense', 
+       1250 AS 'amount' UNION
+    SELECT 'Accommodation', 500 UNION
+    SELECT 'Travel', 720 UNION
+    SELECT 'Misc', 220
+
+And the result of this query is:
+
++---------------+--------+
+| expense       | anount |
++===============+========+
+| Food          | 1250   |
++---------------+--------+
+| Accommodation | 500    |
++---------------+--------+
+| Travel        | 720    |
++---------------+--------+
+| Misc          | 220    |
++---------------+--------+
+
+Choosing expense as the X-axis and amount in series:
+
+.. image:: images/pie_chart.png
+
+Bar and column chart
+++++++++++++++++++++
+
+Both bar charts and column chats support stacking. Upon selecting one of these types a checkbox is displayed to select stacking.
+
+Query results for a simple bar or column chart can be generated with:
+
+.. code-block:: sql
+
+    SELECT 
+       'ACADEMY DINOSAUR' AS 'title',
+       0.99 AS 'rental_rate',
+       20.99 AS 'replacement_cost' UNION
+    SELECT 'ACE GOLDFINGER', 4.99, 12.99 UNION
+    SELECT 'ADAPTATION HOLES', 2.99, 18.99 UNION
+    SELECT 'AFFAIR PREJUDICE', 2.99, 26.99 UNION
+    SELECT 'AFRICAN EGG', 2.99, 22.99
+
+And the result of this query is:
+
++------------------+--------------+-------------------+
+| title            | rental_rate  | replacement_cost  |
++==================+==============+===================+
+| ACADEMY DINOSAUR | 0.99         | 20.99             |
++------------------+--------------+-------------------+
+| ACE GOLDFINGER   | 4.99         | 12.99             |
++------------------+--------------+-------------------+
+| ADAPTATION HOLES | 2.99         | 18.99             |
++------------------+--------------+-------------------+
+| AFFAIR PREJUDICE | 2.99         | 26.99             |
++------------------+--------------+-------------------+
+| AFRICAN EGG      | 2.99         | 22.99             |
++------------------+--------------+-------------------+
+
+Choosing title as the X-axis and rental_rate and replacement_cost as series:
+
+.. image:: images/column_chart.png
+
+Scatter chart
++++++++++++++
+
+Scatter charts are useful in identifying the movement of one or more variable(s) compared to another variable.
+
+Using the same data set from bar and column charts section and choosing replacement_cost as the X-axis and rental_rate in series:
+
+.. image:: images/scatter_chart.png
+
+Line, spline and timeline charts
+++++++++++++++++++++++++++++++++
+
+These charts can be used to illustrate trends in underlying data. Spline charts draw smooth lines while timeline charts draw X-axis taking the distances between the dates/time into consideration.
+
+Query results for a simple line, spline or timeline chart can be generated with:
+
+.. code-block:: sql
+
+    SELECT 
+       DATE('2006-01-08') AS 'date', 
+       2056 AS 'revenue',
+       1378 AS 'cost' UNION
+    SELECT DATE('2006-01-09'), 1898, 2301 UNION
+    SELECT DATE('2006-01-15'), 1560, 600 UNION
+    SELECT DATE('2006-01-17'), 3457, 1565
+
+And the result of this query is:
+
++------------+---------+------+
+| date       | revenue | cost |
++============+=========+======+
+| 2016-01-08 | 2056    | 1378 |
++------------+---------+------+
+| 2006-01-09 | 1898    | 2301 |
++------------+---------+------+
+| 2006-01-15 | 1560    | 600  |
++------------+---------+------+
+| 2006-01-17 | 3457    | 1565 |
++------------+---------+------+
+
+.. image:: images/line_chart.png
+.. image:: images/spline_chart.png
+.. image:: images/timeline_chart.png