=====================
Web Widget JSON Graph
=====================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:c20f0982cec423d84f10e58bdb76234fe13fd54e8215eb02e73bafa01a5ce4cb
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/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-15-0/web-15-0-web_widget_json_graph
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=15.0
    :alt: Try me on Runboat

|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/15.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::

    info = {
        "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::

    plot_dataset = [1, 2, 3, 4, 3, 2]
    labels = ["Jan", "Feb", "Mar", "Apr", "May", "Jun"]
    info = {
        "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
======================

* 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 to smash it by providing a detailed and welcomed
`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.

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
.. |maintainer-frahikLV| image:: https://github.com/frahikLV.png?size=40px
    :target: https://github.com/frahikLV
    :alt: frahikLV

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-luisg123v| |maintainer-frahikLV| 

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.
