======================
Web Widget mpld3 Chart
======================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:a74d15907ff4678410ffd1913b2f75b5c7d818852dc75f13bba0311a6ffeda6e
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/16.0/web_widget_mpld3_chart
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_widget_mpld3_chart
: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=16.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module adds the possibility to insert mpld3 charts into Odoo standard views.
This is an interactive D3js-based viewer which brings matplotlib graphics to the browser.
If you want to see some samples of mpld3's capabilities follow this `link
<http://mpld3.github.io/>`_.
**Table of contents**
.. contents::
:local:
Installation
============
You need to install the python mpld3 library::
pip install mpld3
Usage
=====
To insert a mpld3 chart in a view proceed as follows:
#. You should inherit from abstract class abstract.mpld3.parser::
_name = 'res.partner'
_inherit = ['res.partner', 'abstract.mpld3.parser']
#. Import the required libraries::
import matplotlib.pyplot as plt
#. Declare a json computed field like this::
mpld3_chart = fields.Json(
string='Mpld3 Chart',
compute='_compute_mpld3_chart',
)
#. In its computed method do::
def _compute_mpld3_chart(self):
for rec in self:
# Design your mpld3 figure:
plt.scatter([1, 10], [5, 9])
figure = plt.figure()
rec.mpld3_chart = self.convert_figure_to_json(figure)
#. In the view, add something like this wherever you want to display your
mpld3 chart::
<div>
<field name="mpld3_chart" widget="mpld3_chart" nolabel="1"/>
</div>
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_mpld3_chart%0Aversion:%2016.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
~~~~~~~
* ForgeFlow
Contributors
~~~~~~~~~~~~
* Jordi Ballester Alomar <jordi.ballester@forgeflow.com>
* Christopher Ormaza <chris.ormaza@forgeflow.com>
Other credits
~~~~~~~~~~~~~
* This module uses the library `mpld3 <https://github.com/mpld3/mpld3>`__
which is under the open-source BSD 3-clause "New" or "Revised" License.
Copyright (c) 2013, Jake Vanderplas
* This module uses the library `BeautifulSoup 4 <https://pypi.org/project/beautifulsoup4/>`__
which is under the open-source MIT License.
Copyright (c) 2014, Leonard Richardson
* Odoo Community Association (OCA)
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-JordiBForgeFlow| image:: https://github.com/JordiBForgeFlow.png?size=40px
:target: https://github.com/JordiBForgeFlow
:alt: JordiBForgeFlow
.. |maintainer-ChrisOForgeFlow| image:: https://github.com/ChrisOForgeFlow.png?size=40px
:target: https://github.com/ChrisOForgeFlow
:alt: ChrisOForgeFlow
Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-JordiBForgeFlow| |maintainer-ChrisOForgeFlow|
This module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_widget_mpld3_chart>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/web",
"name": "odoo-addon-web-widget-mpld3-chart",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "ForgeFlow, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": null,
"description": "======================\nWeb Widget mpld3 Chart\n======================\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:a74d15907ff4678410ffd1913b2f75b5c7d818852dc75f13bba0311a6ffeda6e\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github\n :target: https://github.com/OCA/web/tree/16.0/web_widget_mpld3_chart\n :alt: OCA/web\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_widget_mpld3_chart\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=16.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module adds the possibility to insert mpld3 charts into Odoo standard views.\nThis is an interactive D3js-based viewer which brings matplotlib graphics to the browser.\n\nIf you want to see some samples of mpld3's capabilities follow this `link\n<http://mpld3.github.io/>`_.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nInstallation\n============\n\nYou need to install the python mpld3 library::\n\n pip install mpld3\n\nUsage\n=====\n\nTo insert a mpld3 chart in a view proceed as follows:\n\n#. You should inherit from abstract class abstract.mpld3.parser::\n\n _name = 'res.partner'\n _inherit = ['res.partner', 'abstract.mpld3.parser']\n\n#. Import the required libraries::\n\n import matplotlib.pyplot as plt\n\n#. Declare a json computed field like this::\n\n mpld3_chart = fields.Json(\n string='Mpld3 Chart',\n compute='_compute_mpld3_chart',\n )\n\n#. In its computed method do::\n\n def _compute_mpld3_chart(self):\n for rec in self:\n # Design your mpld3 figure:\n plt.scatter([1, 10], [5, 9])\n figure = plt.figure()\n rec.mpld3_chart = self.convert_figure_to_json(figure)\n\n#. In the view, add something like this wherever you want to display your\n mpld3 chart::\n\n <div>\n <field name=\"mpld3_chart\" widget=\"mpld3_chart\" nolabel=\"1\"/>\n </div>\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_mpld3_chart%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* ForgeFlow\n\nContributors\n~~~~~~~~~~~~\n\n* Jordi Ballester Alomar <jordi.ballester@forgeflow.com>\n* Christopher Ormaza <chris.ormaza@forgeflow.com>\n\nOther credits\n~~~~~~~~~~~~~\n\n* This module uses the library `mpld3 <https://github.com/mpld3/mpld3>`__\n which is under the open-source BSD 3-clause \"New\" or \"Revised\" License.\n Copyright (c) 2013, Jake Vanderplas\n* This module uses the library `BeautifulSoup 4 <https://pypi.org/project/beautifulsoup4/>`__\n which is under the open-source MIT License.\n Copyright (c) 2014, Leonard Richardson\n\n* Odoo Community Association (OCA)\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\n.. |maintainer-JordiBForgeFlow| image:: https://github.com/JordiBForgeFlow.png?size=40px\n :target: https://github.com/JordiBForgeFlow\n :alt: JordiBForgeFlow\n.. |maintainer-ChrisOForgeFlow| image:: https://github.com/ChrisOForgeFlow.png?size=40px\n :target: https://github.com/ChrisOForgeFlow\n :alt: ChrisOForgeFlow\n\nCurrent `maintainers <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-JordiBForgeFlow| |maintainer-ChrisOForgeFlow| \n\nThis module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_widget_mpld3_chart>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "This widget allows to display charts using MPLD3 library.",
"version": "16.0.1.0.0.4",
"project_urls": {
"Homepage": "https://github.com/OCA/web"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3288fcce3647f48a200ba80318d473f7e513c4524136cd5a7b5c8388d893ae4",
"md5": "af621a8c07adffcb73fc36de8ce7cbfb",
"sha256": "e06661bc2851d439ac8a1f11d2a4273970f7d651042fd5b94368c92223cecaac"
},
"downloads": -1,
"filename": "odoo_addon_web_widget_mpld3_chart-16.0.1.0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af621a8c07adffcb73fc36de8ce7cbfb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 163758,
"upload_time": "2023-12-04T11:21:23",
"upload_time_iso_8601": "2023-12-04T11:21:23.524865Z",
"url": "https://files.pythonhosted.org/packages/c3/28/8fcce3647f48a200ba80318d473f7e513c4524136cd5a7b5c8388d893ae4/odoo_addon_web_widget_mpld3_chart-16.0.1.0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 11:21:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "web",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo-addon-web-widget-mpld3-chart"
}
JSON
