mirror of https://github.com/OCA/web.git
OCA-git-bot
commit
3038def9b2
|
|
@ -0,0 +1,2 @@
|
|||
# generated from manifests external_dependencies
|
||||
plotly==5.13.1
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../web_widget_plotly_chart
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
import setuptools
|
||||
|
||||
setuptools.setup(
|
||||
setup_requires=['setuptools-odoo'],
|
||||
odoo_addon=True,
|
||||
)
|
||||
|
|
@ -0,0 +1,138 @@
|
|||
=================
|
||||
Web Widget Plotly
|
||||
=================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! 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/16.0/web_widget_plotly_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_plotly_chart
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
||||
:target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/web&target_branch=16.0
|
||||
:alt: Try me on Runboat
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module add the possibility to insert Plotly charts into Odoo standard views.
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_widget_plotly_chart/static/description/example.png
|
||||
:alt: Plotly Chart inserted into an Odoo view
|
||||
:width: 600 px
|
||||
|
||||
`Plotly <https://plot.ly/>`__ is a Python interactive visualization
|
||||
library built on top of d3.js and stack.gl, plotly.js is a high-level,
|
||||
declarative charting library. plotly.js ships with over 40 chart types,
|
||||
including scientific charts, 3D graphs, statistical charts, SVG maps, financial
|
||||
charts, and more.
|
||||
|
||||
If you want to see some samples of plotly's capabilities follow this `link
|
||||
<https://github.com/plotly/plotly.py#overview>`_.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
You need to install the python plotly library::
|
||||
|
||||
pip3 install plotly==5.4.0
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
To insert a Plotly chart in a view proceed as follows:
|
||||
|
||||
#. Declare a text computed field like this::
|
||||
|
||||
plotly_chart = fields.Text(
|
||||
string='Plotly Chart',
|
||||
compute='_compute_plotly_chart',
|
||||
)
|
||||
|
||||
#. In its computed method do::
|
||||
|
||||
def _compute_plotly_chart(self):
|
||||
for rec in self:
|
||||
data = [{'x': [1, 2, 3], 'y': [2, 3, 4]}]
|
||||
rec.plotly_chart = plotly.offline.plot(data,
|
||||
include_plotlyjs=False,
|
||||
output_type='div')
|
||||
|
||||
#. In the view, add something like this wherever you want to display your
|
||||
plotly chart::
|
||||
|
||||
<div>
|
||||
<field name="plotly_chart" widget="plotly_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 smashing it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_plotly_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
|
||||
~~~~~~~
|
||||
|
||||
* LevelPrime srl
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Roberto Fichera <roberto.fichera@levelprime.com>
|
||||
* Michele Zaccheddu <michele.zaccheddu@levelprime.com>
|
||||
|
||||
Other credits
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
* This module uses the library `Plotly.js <https://github.com/plotly/plotly.js>`__
|
||||
which is under the open-source MIT License.
|
||||
Copyright (c) 2019 Plotly, Inc
|
||||
* 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-robyf70| image:: https://github.com/robyf70.png?size=40px
|
||||
:target: https://github.com/robyf70
|
||||
:alt: robyf70
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-robyf70|
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_widget_plotly_chart>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
{
|
||||
"name": "Web Widget Plotly",
|
||||
"summary": """Allow to draw plotly charts.""",
|
||||
"author": "LevelPrime srl, Odoo Community Association (OCA)",
|
||||
"maintainers": ["robyf70"],
|
||||
"website": "https://github.com/OCA/web",
|
||||
"category": "Web",
|
||||
"version": "16.0.1.0.0",
|
||||
"depends": ["web"],
|
||||
"data": [],
|
||||
"external_dependencies": {
|
||||
"python": ["plotly==5.13.1"],
|
||||
},
|
||||
"assets": {
|
||||
"web.assets_backend": [
|
||||
"web_widget_plotly_chart/static/src/js/widget_plotly.esm.js",
|
||||
"web_widget_plotly_chart/static/src/js/widget_plotly.xml",
|
||||
],
|
||||
},
|
||||
"license": "LGPL-3",
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 14.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
* Roberto Fichera <roberto.fichera@levelprime.com>
|
||||
* Michele Zaccheddu <michele.zaccheddu@levelprime.com>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
* This module uses the library `Plotly.js <https://github.com/plotly/plotly.js>`__
|
||||
which is under the open-source MIT License.
|
||||
Copyright (c) 2019 Plotly, Inc
|
||||
* Odoo Community Association (OCA)
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
This module add the possibility to insert Plotly charts into Odoo standard views.
|
||||
|
||||
.. image:: ../static/description/example.png
|
||||
:alt: Plotly Chart inserted into an Odoo view
|
||||
:width: 600 px
|
||||
|
||||
`Plotly <https://plot.ly/>`__ is a Python interactive visualization
|
||||
library built on top of d3.js and stack.gl, plotly.js is a high-level,
|
||||
declarative charting library. plotly.js ships with over 40 chart types,
|
||||
including scientific charts, 3D graphs, statistical charts, SVG maps, financial
|
||||
charts, and more.
|
||||
|
||||
If you want to see some samples of plotly's capabilities follow this `link
|
||||
<https://github.com/plotly/plotly.py#overview>`_.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
You need to install the python plotly library::
|
||||
|
||||
pip3 install plotly==5.4.0
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
To insert a Plotly chart in a view proceed as follows:
|
||||
|
||||
#. Declare a text computed field like this::
|
||||
|
||||
plotly_chart = fields.Text(
|
||||
string='Plotly Chart',
|
||||
compute='_compute_plotly_chart',
|
||||
)
|
||||
|
||||
#. In its computed method do::
|
||||
|
||||
def _compute_plotly_chart(self):
|
||||
for rec in self:
|
||||
data = [{'x': [1, 2, 3], 'y': [2, 3, 4]}]
|
||||
rec.plotly_chart = plotly.offline.plot(data,
|
||||
include_plotlyjs=False,
|
||||
output_type='div')
|
||||
|
||||
#. In the view, add something like this wherever you want to display your
|
||||
plotly chart::
|
||||
|
||||
<div>
|
||||
<field name="plotly_chart" widget="plotly_chart" nolabel="1"/>
|
||||
</div>
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,480 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
|
||||
<title>Web Widget Plotly</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="web-widget-plotly">
|
||||
<h1 class="title">Web Widget Plotly</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_widget_plotly_chart"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_widget_plotly_chart"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runboat.odoo-community.org/webui/builds.html?repo=OCA/web&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This module add the possibility to insert Plotly charts into Odoo standard views.</p>
|
||||
<img alt="Plotly Chart inserted into an Odoo view" src="https://raw.githubusercontent.com/OCA/web/16.0/web_widget_plotly_chart/static/description/example.png" style="width: 600px;" />
|
||||
<p><a class="reference external" href="https://plot.ly/">Plotly</a> is a Python interactive visualization
|
||||
library built on top of d3.js and stack.gl, plotly.js is a high-level,
|
||||
declarative charting library. plotly.js ships with over 40 chart types,
|
||||
including scientific charts, 3D graphs, statistical charts, SVG maps, financial
|
||||
charts, and more.</p>
|
||||
<p>If you want to see some samples of plotly’s capabilities follow this <a class="reference external" href="https://github.com/plotly/plotly.py#overview">link</a>.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
|
||||
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#other-credits" id="id7">Other credits</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="installation">
|
||||
<h1><a class="toc-backref" href="#id1">Installation</a></h1>
|
||||
<p>You need to install the python plotly library:</p>
|
||||
<pre class="literal-block">
|
||||
pip3 install plotly==5.4.0
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
|
||||
<p>To insert a Plotly chart in a view proceed as follows:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Declare a text computed field like this:</p>
|
||||
<pre class="literal-block">
|
||||
plotly_chart = fields.Text(
|
||||
string='Plotly Chart',
|
||||
compute='_compute_plotly_chart',
|
||||
)
|
||||
</pre>
|
||||
</li>
|
||||
<li><p class="first">In its computed method do:</p>
|
||||
<pre class="literal-block">
|
||||
def _compute_plotly_chart(self):
|
||||
for rec in self:
|
||||
data = [{'x': [1, 2, 3], 'y': [2, 3, 4]}]
|
||||
rec.plotly_chart = plotly.offline.plot(data,
|
||||
include_plotlyjs=False,
|
||||
output_type='div')
|
||||
</pre>
|
||||
</li>
|
||||
<li><p class="first">In the view, add something like this wherever you want to display your
|
||||
plotly chart:</p>
|
||||
<pre class="literal-block">
|
||||
<div>
|
||||
<field name="plotly_chart" widget="plotly_chart" nolabel="1"/>
|
||||
</div>
|
||||
</pre>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
|
||||
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
|
||||
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_widget_plotly_chart%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>LevelPrime srl</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Roberto Fichera <<a class="reference external" href="mailto:roberto.fichera@levelprime.com">roberto.fichera@levelprime.com</a>></li>
|
||||
<li>Michele Zaccheddu <<a class="reference external" href="mailto:michele.zaccheddu@levelprime.com">michele.zaccheddu@levelprime.com</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="other-credits">
|
||||
<h2><a class="toc-backref" href="#id7">Other credits</a></h2>
|
||||
<ul class="simple">
|
||||
<li>This module uses the library <a class="reference external" href="https://github.com/plotly/plotly.js">Plotly.js</a>
|
||||
which is under the open-source MIT License.
|
||||
Copyright (c) 2019 Plotly, Inc</li>
|
||||
<li>Odoo Community Association (OCA)</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||
<p>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.</p>
|
||||
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||||
<p><a class="reference external" href="https://github.com/robyf70"><img alt="robyf70" src="https://github.com/robyf70.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_widget_plotly_chart">OCA/web</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
/** @odoo-module **/
|
||||
|
||||
import {loadJS} from "@web/core/assets";
|
||||
import {registry} from "@web/core/registry";
|
||||
|
||||
import {Component, onPatched, onWillStart, useEffect, useRef} from "@odoo/owl";
|
||||
|
||||
export class PlotlyChartWidgetField extends Component {
|
||||
setup() {
|
||||
this.divRef = useRef("plotly");
|
||||
|
||||
onWillStart(async () => {
|
||||
await loadJS(
|
||||
"/web_widget_plotly_chart/static/src/lib/plotly/plotly-2.18.2.min.js"
|
||||
);
|
||||
this.updatePlotly(this.props.value);
|
||||
});
|
||||
|
||||
onPatched(() => {
|
||||
this.updatePlotly(this.props.value);
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
this.updatePlotly(this.props.value);
|
||||
});
|
||||
}
|
||||
updatePlotly(value) {
|
||||
const value_html = $(value);
|
||||
const div = value_html.find(".plotly-graph-div").get(0).outerHTML || "";
|
||||
const script = value_html.find("script").get(0).textContent || "";
|
||||
|
||||
if (this.divRef.el) {
|
||||
this.divRef.el.innerHTML = div;
|
||||
new Function(script)();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
PlotlyChartWidgetField.template = "web_widget_plotly_chart.PlotlyChartWidgetField";
|
||||
PlotlyChartWidgetField.supportedTypes = ["char", "text"];
|
||||
|
||||
registry.category("fields").add("plotly_chart", PlotlyChartWidgetField);
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<templates xml:space="preserve">
|
||||
|
||||
<t t-name="web_widget_plotly_chart.PlotlyChartWidgetField" owl="1">
|
||||
<div t-ref="plotly" />
|
||||
</t>
|
||||
|
||||
</templates>
|
||||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue