Skip to main content

This widget allows to display charts using MPLD3 library.

Project description

Beta License: LGPL-3 OCA/web Translate me on Weblate Try me on Runboat

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.

Table of contents

Installation

You need to install the python mpld3 library:

pip install mpld3

Usage

To insert a mpld3 chart in a view proceed as follows:

  1. You should inherit from abstract class abstract.mpld3.parser:

    _name = 'res.partner'
    _inherit = ['res.partner', 'abstract.mpld3.parser']
  2. Import the required libraries:

    import matplotlib.pyplot as plt
  3. Declare a json computed field like this:

    mpld3_chart = fields.Json(
        string='Mpld3 Chart',
        compute='_compute_mpld3_chart',
    )
  4. 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)
  5. 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. 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.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • ForgeFlow

Contributors

Other credits

  • This module uses the library 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 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.

Odoo Community Association

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.

Current maintainers:

JordiBForgeFlow ChrisOForgeFlow

This module is part of the OCA/web project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file odoo_addon_web_widget_mpld3_chart-16.0.1.0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_web_widget_mpld3_chart-16.0.1.0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9a3b5ae6910dd951165c4f3bfadcbdcbc9a688117ad54ddb0074833d204a392d
MD5 472ba25f547cf95ba1caa9b6c45ce7d3
BLAKE2b-256 7919bc2278f447172d751170bae65b1d799a6400725ef623417ffaaf72906f00

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page