[UPD] README.rst

kanda999 · May 21, 2022 · 9b02995 · 9b02995
1 parent 043bd57
commit 9b02995
Show file tree

Hide file tree

Showing 2 changed files with 106 additions and 116 deletions.
diff --git a/web_widget_json_graph/README.rst b/web_widget_json_graph/README.rst
@@ -14,21 +14,21 @@ Web Widget JSON Graph
     :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
     :alt: License: LGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
-    :target: https://github.com/OCA/web/tree/12.0/web_widget_json_graph
+    :target: https://github.com/OCA/web/tree/15.0/web_widget_json_graph
     :alt: OCA/web
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_widget_json_graph
+    :target: https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_widget_json_graph
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
-    :target: https://runbot.odoo-community.org/runbot/162/12.0
+    :target: https://runbot.odoo-community.org/runbot/162/15.0
     :alt: Try me on Runbot
 
 |badge1| |badge2| |badge3| |badge4| |badge5| 
 
 This module allows to load a line graph per ordered pair from an One2many or
 Many2many field.
 
-.. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_widget_json_graph/static/description/widget_in_action.png
+.. image:: https://raw.githubusercontent.com/OCA/web/15.0/web_widget_json_graph/static/description/widget_in_action.png
    :width: 400px
    :alt: Widget in action
 
@@ -50,78 +50,72 @@ For example::
 
 The JSON needs to be like::
 
-    fields = ['field1', 'field2', 'field3', ...]
-    field_x = 'field_x'
-    dictionary = self.value_ids.sorted(field_x).read(fields)
-    color = {
-        'field1': HEXCOLOR1,
-        'field2': '#FFBB78',
-        'field3': '#1F77B4',
-        ...
-    }
-    dictionary = self.value_ids.sorted(field_x).read(fields)
-    content = {}
-    data = []
-    for field in fields:
-        if field != field_x:
-            content[field] = []
-            for rec in dictionary:
-                content[field].append({'x': rec[field_x], 'y': rec[field]})
-            if field in color:
-                data.append({'values': content[field], 'key': field,
-                    'color': color[field]})
-                continue
-            data.append({'values': content[field], 'key': field})
     info = {
-        'label_x': 'X Label',
-        'label_y': 'Y label',
-        'data': data
+        "type": "line",
+        "data": {"datasets": [], "labels": []},
+        "options": {
+            "scales": {
+                "yAxes": [
+                    {
+                        "ticks": {"beginAtZero": True, "stacked": False},
+                        "scaleLabel": {"display": True, "labelString": "Quantity"},
+                    }
+                ],
+                "xAxes": [
+                    {
+                        "scaleLabel": {"display": True, "labelString": "Date"},
+                    }
+                ],
+            },
+            "elements": {"point": {"radius": 3}},
+            "legend": {"labels": {"usePointStyle": True}},
+            "tooltips": {"intersect": False, "axis": "xy", "mode": "index"},
+        },
     }
     self.field_text_json = json.dumps(info)
 
 For example::
 
-    fields = ['sequence', 'value', 'sma', 'cma']
-    field_x = 'sequence'
-    dictionary = self.value_ids.sorted(field_x).read(fields)
-    color = {
-        'value': '#2CA02C',
-        'sma': '#FFBB78'
-    }
-    dictionary = self.value_ids.sorted(field_x).read(fields)
-    content = {}
-    data = []
-    for field in fields:
-        if field != field_x:
-            content[field] = []
-            for rec in dictionary:
-                content[field].append({'x': rec[field_x], 'y': rec[field]})
-            if field in color:
-                data.append({'values': content[field], 'key': field,
-                    'color': color[field]})
-                continue
-            data.append({'values': content[field], 'key': field})
+    plot_dataset = [1, 2, 3, 4, 3, 2]
+    labels = ["Jan", "Feb", "Mar", "Apr", "May", "Jun"]
     info = {
-        'label_x': 'Sequence',
-        'label_y': '',
-        'data': data
+        "type": "line",
+        "data": {"datasets": plot_dataset, "labels": labels},
+        "options": {
+            "scales": {
+                "yAxes": [
+                    {
+                        "ticks": {"beginAtZero": True, "stacked": False},
+                        "scaleLabel": {"display": True, "labelString": "Quantity"},
+                    }
+                ],
+                "xAxes": [
+                    {
+                        "scaleLabel": {"display": True, "labelString": "Date"},
+                    }
+                ],
+            },
+            "elements": {"point": {"radius": 3}},
+            "legend": {"labels": {"usePointStyle": True}},
+            "tooltips": {"intersect": False, "axis": "xy", "mode": "index"},
+        },
     }
     self.values_data = json.dumps(info)
 
+For more information, please see `Chart Js Documentation <https://www.chartjs.org/docs/2.9.4/>`.
+
 Known issues / Roadmap
 ======================
 
-* ``nolabel`` is ignored, this image will never bring a label, by default simply use an extra separator.
-* A graph will always use 100% of the width, pending the css dynamic attribute.
-* Height is harcoded.
+* None
 
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us smashing it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_json_graph%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_json_graph%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -162,11 +156,14 @@ promote its widespread use.
 .. |maintainer-luisg123v| image:: https://github.com/luisg123v.png?size=40px
     :target: https://github.com/luisg123v
     :alt: luisg123v
+.. |maintainer-frahikLV| image:: https://github.com/frahikLV.png?size=40px
+    :target: https://github.com/frahikLV
+    :alt: frahikLV
 
-Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
 
-|maintainer-luisg123v| 
+|maintainer-luisg123v| |maintainer-frahikLV| 
 
-This module is part of the `OCA/web <https://github.com/OCA/web/tree/12.0/web_widget_json_graph>`_ project on GitHub.
+This module is part of the `OCA/web <https://github.com/OCA/web/tree/15.0/web_widget_json_graph>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
diff --git a/web_widget_json_graph/static/description/index.html b/web_widget_json_graph/static/description/index.html
@@ -367,10 +367,10 @@ <h1 class="title">Web Widget JSON Graph</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/12.0/web_widget_json_graph"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_widget_json_graph"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/15.0/web_widget_json_graph"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_widget_json_graph"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
 <p>This module allows to load a line graph per ordered pair from an One2many or
 Many2many field.</p>
-<img alt="Widget in action" src="https://raw.githubusercontent.com/OCA/web/12.0/web_widget_json_graph/static/description/widget_in_action.png" style="width: 400px;" />
+<img alt="Widget in action" src="https://raw.githubusercontent.com/OCA/web/15.0/web_widget_json_graph/static/description/widget_in_action.png" style="width: 400px;" />
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -398,79 +398,72 @@ <h1><a class="toc-backref" href="#id1">Usage</a></h1>
 </pre>
 <p>The JSON needs to be like:</p>
 <pre class="literal-block">
-fields = ['field1', 'field2', 'field3', ...]
-field_x = 'field_x'
-dictionary = self.value_ids.sorted(field_x).read(fields)
-color = {
-    'field1': HEXCOLOR1,
-    'field2': '#FFBB78',
-    'field3': '#1F77B4',
-    ...
-}
-dictionary = self.value_ids.sorted(field_x).read(fields)
-content = {}
-data = []
-for field in fields:
-    if field != field_x:
-        content[field] = []
-        for rec in dictionary:
-            content[field].append({'x': rec[field_x], 'y': rec[field]})
-        if field in color:
-            data.append({'values': content[field], 'key': field,
-                'color': color[field]})
-            continue
-        data.append({'values': content[field], 'key': field})
 info = {
-    'label_x': 'X Label',
-    'label_y': 'Y label',
-    'data': data
+    &quot;type&quot;: &quot;line&quot;,
+    &quot;data&quot;: {&quot;datasets&quot;: [], &quot;labels&quot;: []},
+    &quot;options&quot;: {
+        &quot;scales&quot;: {
+            &quot;yAxes&quot;: [
+                {
+                    &quot;ticks&quot;: {&quot;beginAtZero&quot;: True, &quot;stacked&quot;: False},
+                    &quot;scaleLabel&quot;: {&quot;display&quot;: True, &quot;labelString&quot;: &quot;Quantity&quot;},
+                }
+            ],
+            &quot;xAxes&quot;: [
+                {
+                    &quot;scaleLabel&quot;: {&quot;display&quot;: True, &quot;labelString&quot;: &quot;Date&quot;},
+                }
+            ],
+        },
+        &quot;elements&quot;: {&quot;point&quot;: {&quot;radius&quot;: 3}},
+        &quot;legend&quot;: {&quot;labels&quot;: {&quot;usePointStyle&quot;: True}},
+        &quot;tooltips&quot;: {&quot;intersect&quot;: False, &quot;axis&quot;: &quot;xy&quot;, &quot;mode&quot;: &quot;index&quot;},
+    },
 }
 self.field_text_json = json.dumps(info)
 </pre>
 <p>For example:</p>
 <pre class="literal-block">
-fields = ['sequence', 'value', 'sma', 'cma']
-field_x = 'sequence'
-dictionary = self.value_ids.sorted(field_x).read(fields)
-color = {
-    'value': '#2CA02C',
-    'sma': '#FFBB78'
-}
-dictionary = self.value_ids.sorted(field_x).read(fields)
-content = {}
-data = []
-for field in fields:
-    if field != field_x:
-        content[field] = []
-        for rec in dictionary:
-            content[field].append({'x': rec[field_x], 'y': rec[field]})
-        if field in color:
-            data.append({'values': content[field], 'key': field,
-                'color': color[field]})
-            continue
-        data.append({'values': content[field], 'key': field})
+plot_dataset = [1, 2, 3, 4, 3, 2]
+labels = [&quot;Jan&quot;, &quot;Feb&quot;, &quot;Mar&quot;, &quot;Apr&quot;, &quot;May&quot;, &quot;Jun&quot;]
 info = {
-    'label_x': 'Sequence',
-    'label_y': '',
-    'data': data
+    &quot;type&quot;: &quot;line&quot;,
+    &quot;data&quot;: {&quot;datasets&quot;: plot_dataset, &quot;labels&quot;: labels},
+    &quot;options&quot;: {
+        &quot;scales&quot;: {
+            &quot;yAxes&quot;: [
+                {
+                    &quot;ticks&quot;: {&quot;beginAtZero&quot;: True, &quot;stacked&quot;: False},
+                    &quot;scaleLabel&quot;: {&quot;display&quot;: True, &quot;labelString&quot;: &quot;Quantity&quot;},
+                }
+            ],
+            &quot;xAxes&quot;: [
+                {
+                    &quot;scaleLabel&quot;: {&quot;display&quot;: True, &quot;labelString&quot;: &quot;Date&quot;},
+                }
+            ],
+        },
+        &quot;elements&quot;: {&quot;point&quot;: {&quot;radius&quot;: 3}},
+        &quot;legend&quot;: {&quot;labels&quot;: {&quot;usePointStyle&quot;: True}},
+        &quot;tooltips&quot;: {&quot;intersect&quot;: False, &quot;axis&quot;: &quot;xy&quot;, &quot;mode&quot;: &quot;index&quot;},
+    },
 }
 self.values_data = json.dumps(info)
 </pre>
+<p>For more information, please see <cite>Chart Js Documentation &lt;https://www.chartjs.org/docs/2.9.4/&gt;</cite>.</p>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
 <ul class="simple">
-<li><tt class="docutils literal">nolabel</tt> is ignored, this image will never bring a label, by default simply use an extra separator.</li>
-<li>A graph will always use 100% of the width, pending the css dynamic attribute.</li>
-<li>Height is harcoded.</li>
+<li>None</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us smashing it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_widget_json_graph%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_widget_json_graph%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -501,9 +494,9 @@ <h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>
-<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
-<p><a class="reference external" href="https://github.com/luisg123v"><img alt="luisg123v" src="https://github.com/luisg123v.png?size=40px" /></a></p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/12.0/web_widget_json_graph">OCA/web</a> project on GitHub.</p>
+<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
+<p><a class="reference external" href="https://github.com/luisg123v"><img alt="luisg123v" src="https://github.com/luisg123v.png?size=40px" /></a> <a class="reference external" href="https://github.com/frahikLV"><img alt="frahikLV" src="https://github.com/frahikLV.png?size=40px" /></a></p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/15.0/web_widget_json_graph">OCA/web</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>