Skip to main content

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 ThiagoMForgeFlow

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.

Release files for odoo-addon-web-widget-mpld3-chart 18.0.1.0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-web-widget-mpld3-chart 18.0.1.0.0.4
File Interpreter ABI Platform
odoo_addon_web_widget_mpld3_chart-18.0.1.0.0.4-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_web_widget_mpld3_chart-18.0.1.0.0.4-py3-none-any.whl

Download URL odoo_addon_web_widget_mpld3_chart-18.0.1.0.0.4-py3-none-any.whl
Size 165.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9bb37785d4f6a91cdcbb0f77ef1926b4452d7165ff80aa3fdb95746e2d0e5af4
BLAKE2b-256 checksum
How to use checksums
fd4973ef2b449d5748c5ac010aac33d8c7527ffe632b1b78f32f797abd62b741
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page