mirror of
https://github.com/OCA/web.git
synced 2025-02-22 13:21:25 +02:00
[ADD] web_widget_json_graph: Module to Draw json fields with graphs (#1733)
This module allows to load a line graph per ordered pair from an One2many or Many2many field. Co-Authored-By: Francisco Luna <fluna@vauxoo.com> Co-Authored-By: José Robles <josemanuel@vauxoo.com> Co-Authored-By: Luis González <lgonzalez@vauxoo.com> Co-Authored-By: Nhomar Hernández <nhomar@vauxoo.com> Co-authored-by: Francisco Luna <fluna@vauxoo.com> Co-authored-by: José Robles <josemanuel@vauxoo.com> Co-authored-by: Nhomar Hernández <nhomar@vauxoo.com>
This commit is contained in:
Luis González [Vauxoo]
committed by
Francisco Javier Luna Vazquez
Francisco Javier Luna Vazquez
parent
d4704c67c4
commit
802570e791
173
web_widget_json_graph/README.rst
Normal file
173
web_widget_json_graph/README.rst
Normal file
@@ -0,0 +1,173 @@
|
||||
=====================
|
||||
Web Widget JSON Graph
|
||||
=====================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
|
||||
: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
|
||||
: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
|
||||
: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
|
||||
: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
|
||||
:width: 400px
|
||||
:alt: Widget in action
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
Use this widget by including::
|
||||
|
||||
<field name="field_text_json" widget="json_graph" />
|
||||
|
||||
For example::
|
||||
|
||||
<field name="values_data" widget="json_graph"/>
|
||||
|
||||
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
|
||||
}
|
||||
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})
|
||||
info = {
|
||||
'label_x': 'Sequence',
|
||||
'label_y': '',
|
||||
'data': data
|
||||
}
|
||||
self.values_data = json.dumps(info)
|
||||
|
||||
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.
|
||||
|
||||
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**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* Vauxoo
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Francisco Luna <fluna@vauxoo.com>
|
||||
* José Robles <josemanuel@vauxoo.com>
|
||||
* Luis González <lgonzalez@vauxoo.com>
|
||||
* Nhomar Hernández <nhomar@vauxoo.com>
|
||||
|
||||
|
||||
Other credits
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Vauxoo
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
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.
|
||||
|
||||
.. |maintainer-luisg123v| image:: https://github.com/luisg123v.png?size=40px
|
||||
:target: https://github.com/luisg123v
|
||||
:alt: luisg123v
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-luisg123v|
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/12.0/web_widget_json_graph>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
Reference in New Issue
Block a user