From 33f9e90bd5a9ad3e9239f1b414ea012bb94fa1c0 Mon Sep 17 00:00:00 2001
From: qsm-odoo <qsm@odoo.com>
Date: Thu, 14 Sep 2017 22:43:43 +0200
Subject: [IMP] web, *: add kanban column progress bars

* crm, project

Add a new feature which allows to put a progressbar in the kanban
columns. The progressbar shows with the same color the amount of
records whose value of a given field are the same in the column.
It also indicate the sum of another given field or simply the total
number of records. It also allows to subgroup the column content.

To define a progressbar, add this as a direct child of the kanban
arch:

<progressbar field="<name of the field to use for subgroups>"
             colors="{<one possible value for the above field>: <success, warning or danger>, ...}"
             sum="<name of the field to sum or nothing to use total number of records>"/>

Also:
- Properly update record model data's parentID when moving a record
- ...
---
 doc/reference/views.rst | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

(limited to 'doc/reference')

diff --git a/doc/reference/views.rst b/doc/reference/views.rst
index d5e5b10c58c..149d22b277b 100644
--- a/doc/reference/views.rst
+++ b/doc/reference/views.rst
@@ -797,7 +797,7 @@ following attributes:
 Pivots
 ------
 
-The pivot view is used to visualize aggregations as a `pivot table`_. Its root 
+The pivot view is used to visualize aggregations as a `pivot table`_. Its root
 element is ``<pivot>`` which can take the following attributes:
 
 ``disable_linking``
@@ -854,6 +854,24 @@ Possible children of the view element are:
   ``name`` (required)
     the name of the field to fetch
 
+``progressbar``
+  declares a progressbar element to put on top of kanban columns.
+
+  Possible attributes are:
+
+  ``field`` (required)
+    the name of the field whose values are used to subgroup column's records in
+    the progressbar
+
+  ``colors`` (required)
+    JSON mapping the above field values to either "danger", "warning" or
+    "success" colors
+
+  ``sum`` (optional)
+    the name of the field whose column's records' values will be summed and
+    displayed next to the progressbar (if omitted, displays the total number of
+    records)
+
 ``templates``
   defines a list of :ref:`reference/qweb` templates. Cards definition may be
   split into multiple templates for clarity, but kanban views *must* define at
@@ -1067,7 +1085,7 @@ take the following attributes:
   ``gantt`` classic gantt view (default)
 
   ``consolidate`` values of the first children are consolidated in the gantt's task
-  
+
   ``planning`` children are displayed in the gantt's task
 ``consolidation``
   field name to display consolidation value in record cell
-- 
cgit v1.2.3