Enric Tobella
5 years ago
18 changed files with 786 additions and 0 deletions
-
113kpi_dashboard_altair/README.rst
-
1kpi_dashboard_altair/__init__.py
-
20kpi_dashboard_altair/__manifest__.py
-
33kpi_dashboard_altair/demo/demo_dashboard_altair.xml
-
1kpi_dashboard_altair/models/__init__.py
-
28kpi_dashboard_altair/models/kpi_kpi.py
-
28kpi_dashboard_altair/readme/CONFIGURE.rst
-
1kpi_dashboard_altair/readme/CONTRIBUTORS.rst
-
1kpi_dashboard_altair/readme/DESCRIPTION.rst
-
BINkpi_dashboard_altair/static/description/icon.png
-
456kpi_dashboard_altair/static/description/index.html
-
26kpi_dashboard_altair/static/lib/vega/vega-embed.min.js
-
15kpi_dashboard_altair/static/lib/vega/vega-lite.min.js
-
1kpi_dashboard_altair/static/lib/vega/vega.min.js
-
38kpi_dashboard_altair/static/src/js/altair_widget.js
-
9kpi_dashboard_altair/static/src/xml/dashboard.xml
-
14kpi_dashboard_altair/views/webclient_templates.xml
-
1requirements.txt
@ -0,0 +1,113 @@ |
|||
==================== |
|||
Kpi Dashboard Altair |
|||
==================== |
|||
|
|||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
|||
!! 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-AGPL--3-blue.png |
|||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
|||
:alt: License: AGPL-3 |
|||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github |
|||
:target: https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard_altair |
|||
:alt: OCA/reporting-engine |
|||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
|||
:target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-kpi_dashboard_altair |
|||
:alt: Translate me on Weblate |
|||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png |
|||
:target: https://runbot.odoo-community.org/runbot/143/12.0 |
|||
:alt: Try me on Runbot |
|||
|
|||
|badge1| |badge2| |badge3| |badge4| |badge5| |
|||
|
|||
Define KPI graphs using altair |
|||
|
|||
**Table of contents** |
|||
|
|||
.. contents:: |
|||
:local: |
|||
|
|||
Configuration |
|||
============= |
|||
|
|||
Configure KPIs |
|||
~~~~~~~~~~~~~~ |
|||
|
|||
#. Access `Dashboards > Configuration > KPI Dashboards > Configure KPI` |
|||
#. Create a new kpi with widget `altair` |
|||
|
|||
You need to define a function like:: |
|||
|
|||
import pandas |
|||
import altair |
|||
|
|||
|
|||
class Kpi(models.Model): |
|||
_inherit = 'kpi.kpi' |
|||
|
|||
def test_demo_altair(self): |
|||
source = pandas.DataFrame( |
|||
{ |
|||
"a": ["A", "B", "C", "D", "E", "F", "G", "H", "I"], |
|||
"b": [28, 55, 43, 91, 81, 53, 19, 87, 52], |
|||
} |
|||
) |
|||
chart = altair.Chart(source).mark_bar().encode(x="a", y="b") |
|||
return {"altair": json.loads(chart.to_json())} |
|||
|
|||
|
|||
You can use `code` in a similar way, as `pandas` and `altair` are already defined |
|||
when using `code` on an `altair` widget. |
|||
|
|||
Bug Tracker |
|||
=========== |
|||
|
|||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20kpi_dashboard_altair%0Aversion:%2012.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 |
|||
~~~~~~~ |
|||
|
|||
* Creu Blanca |
|||
|
|||
Contributors |
|||
~~~~~~~~~~~~ |
|||
|
|||
* Enric Tobella <etobella@creublanca.es> |
|||
|
|||
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-etobella| image:: https://github.com/etobella.png?size=40px |
|||
:target: https://github.com/etobella |
|||
:alt: etobella |
|||
|
|||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: |
|||
|
|||
|maintainer-etobella| |
|||
|
|||
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard_altair>`_ project on GitHub. |
|||
|
|||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
|||
@ -0,0 +1 @@ |
|||
from . import models |
|||
@ -0,0 +1,20 @@ |
|||
# Copyright 2020 Creu Blanca |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). |
|||
|
|||
{ |
|||
"name": "Kpi Dashboard Altair", |
|||
"summary": """ |
|||
Create dashboards using altair""", |
|||
"version": "12.0.1.0.0", |
|||
"license": "AGPL-3", |
|||
"author": "Creu Blanca,Odoo Community Association (OCA)", |
|||
"website": "https://github.com/OCA/reporting-engine", |
|||
"depends": ["kpi_dashboard"], |
|||
"data": ["views/webclient_templates.xml"], |
|||
"qweb": ["static/src/xml/dashboard.xml"], |
|||
"external_dependencies": { |
|||
"python": ['altair'], |
|||
}, |
|||
"demo": ["demo/demo_dashboard_altair.xml"], |
|||
"maintainers": ["etobella"], |
|||
} |
|||
@ -0,0 +1,33 @@ |
|||
<?xml version="1.0" encoding="UTF-8" ?> |
|||
<odoo> |
|||
<record id="widget_altair" model="kpi.kpi"> |
|||
<field name="name">Altair 01</field> |
|||
<field name="computation_method">code</field> |
|||
<field name="widget">altair</field> |
|||
<field name="code"> |
|||
source = pandas.DataFrame( |
|||
{ |
|||
"a": ["A", "B", "C", "D", "E", "F", "G", "H", "I"], |
|||
"b": [28, 55, 43, 91, 81, 53, 19, 87, 52], |
|||
} |
|||
) |
|||
chart = altair.Chart(source, background="transparent").mark_bar().encode(x="a", y="b") |
|||
result = {"altair": json.loads(chart.to_json())} |
|||
</field> |
|||
</record> |
|||
|
|||
<function model="kpi.kpi" name="compute" |
|||
eval="[[ref('widget_altair')]]"/> |
|||
|
|||
<record id="dashboard_widget_altair" model="kpi.dashboard.item"> |
|||
<field name="name">Altair</field> |
|||
<field name="kpi_id" ref="widget_altair"/> |
|||
<field name="column">1</field> |
|||
<field name="row">10</field> |
|||
<field name="size_y">4</field> |
|||
<field name="color">#47bbb3</field> |
|||
<field name="dashboard_id" ref="kpi_dashboard.demo_dashboard"/> |
|||
<field name="font_color">#ffffff</field> |
|||
</record> |
|||
|
|||
</odoo> |
|||
@ -0,0 +1 @@ |
|||
from . import kpi_kpi |
|||
@ -0,0 +1,28 @@ |
|||
# Copyright 2020 Creu Blanca |
|||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). |
|||
from odoo import fields, models |
|||
import logging |
|||
import json |
|||
logger = logging.getLogger(__name__) |
|||
try: |
|||
import pandas |
|||
import altair |
|||
except ImportError: |
|||
logger.debug('Cannot import genshi.core') |
|||
|
|||
|
|||
class KpiKpi(models.Model): |
|||
|
|||
_inherit = "kpi.kpi" |
|||
|
|||
widget = fields.Selection(selection_add=[("altair", "Altair")]) |
|||
|
|||
def _get_code_input_dict(self): |
|||
res = super()._get_code_input_dict() |
|||
if self.widget == 'altair': |
|||
res.update({ |
|||
'json': json, |
|||
'altair': altair, |
|||
'pandas': pandas, |
|||
}) |
|||
return res |
|||
@ -0,0 +1,28 @@ |
|||
Configure KPIs |
|||
~~~~~~~~~~~~~~ |
|||
|
|||
#. Access `Dashboards > Configuration > KPI Dashboards > Configure KPI` |
|||
#. Create a new kpi with widget `altair` |
|||
|
|||
You need to define a function like:: |
|||
|
|||
import pandas |
|||
import altair |
|||
|
|||
|
|||
class Kpi(models.Model): |
|||
_inherit = 'kpi.kpi' |
|||
|
|||
def test_demo_altair(self): |
|||
source = pandas.DataFrame( |
|||
{ |
|||
"a": ["A", "B", "C", "D", "E", "F", "G", "H", "I"], |
|||
"b": [28, 55, 43, 91, 81, 53, 19, 87, 52], |
|||
} |
|||
) |
|||
chart = altair.Chart(source).mark_bar().encode(x="a", y="b") |
|||
return {"altair": json.loads(chart.to_json())} |
|||
|
|||
|
|||
You can use `code` in a similar way, as `pandas` and `altair` are already defined |
|||
when using `code` on an `altair` widget. |
|||
@ -0,0 +1 @@ |
|||
* Enric Tobella <etobella@creublanca.es> |
|||
@ -0,0 +1 @@ |
|||
Define KPI graphs using altair |
|||
|
After Width: 128 | Height: 128 | Size: 9.2 KiB |
@ -0,0 +1,456 @@ |
|||
<?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 0.14: http://docutils.sourceforge.net/" /> |
|||
<title>Kpi Dashboard Altair</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="kpi-dashboard-altair"> |
|||
<h1 class="title">Kpi Dashboard Altair</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/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard_altair"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-kpi_dashboard_altair"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> |
|||
<p>Define KPI graphs using altair</p> |
|||
<p><strong>Table of contents</strong></p> |
|||
<div class="contents local topic" id="contents"> |
|||
<ul class="simple"> |
|||
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a><ul> |
|||
<li><a class="reference internal" href="#configure-kpis" id="id2">Configure KPIs</a></li> |
|||
</ul> |
|||
</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="#maintainers" id="id7">Maintainers</a></li> |
|||
</ul> |
|||
</li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="configuration"> |
|||
<h1><a class="toc-backref" href="#id1">Configuration</a></h1> |
|||
<div class="section" id="configure-kpis"> |
|||
<h2><a class="toc-backref" href="#id2">Configure KPIs</a></h2> |
|||
<ol class="arabic simple"> |
|||
<li>Access <cite>Dashboards > Configuration > KPI Dashboards > Configure KPI</cite></li> |
|||
<li>Create a new kpi with widget <cite>altair</cite></li> |
|||
</ol> |
|||
<p>You need to define a function like:</p> |
|||
<pre class="literal-block"> |
|||
import pandas |
|||
import altair |
|||
|
|||
|
|||
class Kpi(models.Model): |
|||
_inherit = 'kpi.kpi' |
|||
|
|||
def test_demo_altair(self): |
|||
source = pandas.DataFrame( |
|||
{ |
|||
"a": ["A", "B", "C", "D", "E", "F", "G", "H", "I"], |
|||
"b": [28, 55, 43, 91, 81, 53, 19, 87, 52], |
|||
} |
|||
) |
|||
chart = altair.Chart(source).mark_bar().encode(x="a", y="b") |
|||
return {"altair": json.loads(chart.to_json())} |
|||
</pre> |
|||
<p>You can use <cite>code</cite> in a similar way, as <cite>pandas</cite> and <cite>altair</cite> are already defined |
|||
when using <cite>code</cite> on an <cite>altair</cite> widget.</p> |
|||
</div> |
|||
</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/reporting-engine/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/reporting-engine/issues/new?body=module:%20kpi_dashboard_altair%0Aversion:%2012.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>Creu Blanca</li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="contributors"> |
|||
<h2><a class="toc-backref" href="#id6">Contributors</a></h2> |
|||
<ul class="simple"> |
|||
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li> |
|||
</ul> |
|||
</div> |
|||
<div class="section" id="maintainers"> |
|||
<h2><a class="toc-backref" href="#id7">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/etobella"><img alt="etobella" src="https://github.com/etobella.png?size=40px" /></a></p> |
|||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard_altair">OCA/reporting-engine</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> |
|||
26
kpi_dashboard_altair/static/lib/vega/vega-embed.min.js
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
15
kpi_dashboard_altair/static/lib/vega/vega-lite.min.js
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
1
kpi_dashboard_altair/static/lib/vega/vega.min.js
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
@ -0,0 +1,38 @@ |
|||
odoo.define('kpi_dashboard.AltairWidget', function (require) { |
|||
"use strict"; |
|||
|
|||
var AbstractWidget = require('kpi_dashboard.AbstractWidget'); |
|||
var registry = require('kpi_dashboard.widget_registry'); |
|||
|
|||
var AltairWidget = AbstractWidget.extend({ |
|||
template: 'kpi_dashboard.altair', |
|||
fillWidget: function (values) { |
|||
var widget = this.$el.find('[data-bind="value"]'); |
|||
widget.css('width', this.widget_size_x-20); |
|||
widget.css('height', this.widget_size_y-90); |
|||
var data = $.extend({ |
|||
height: this.widget_size_y - 90, |
|||
width: this.widget_size_x - 20, |
|||
autosize: { |
|||
type: "fit", |
|||
contains: "padding" |
|||
}, |
|||
}, values.value.altair); |
|||
vegaEmbed( |
|||
widget[0], |
|||
data, |
|||
this.altairOptions(values) |
|||
); |
|||
}, |
|||
altairOptions: function () { |
|||
return { |
|||
actions: false, |
|||
height: this.widget_size_y - 90, |
|||
width: this.widget_size_x - 40, |
|||
}; |
|||
}, |
|||
}); |
|||
|
|||
registry.add('altair', AltairWidget); |
|||
return AltairWidget; |
|||
}); |
|||
@ -0,0 +1,9 @@ |
|||
<?xml version="1.0" encoding="UTF-8" ?> |
|||
<template> |
|||
<t t-name="kpi_dashboard.altair" t-extend="kpi_dashboard.base_widget"> |
|||
<t t-jquery="h1" t-operation="after"> |
|||
<div data-bind="value"/> |
|||
</t> |
|||
</t> |
|||
|
|||
</template> |
|||
@ -0,0 +1,14 @@ |
|||
<?xml version="1.0" encoding="utf-8"?> |
|||
<odoo> |
|||
|
|||
<template id="assets_backend" |
|||
name="Backend Assets (used in backend interface)" |
|||
inherit_id="web.assets_backend"> |
|||
<xpath expr="." position="inside"> |
|||
<script type="text/javascript" src="/kpi_dashboard_altair/static/lib/vega/vega.min.js"/> |
|||
<script type="text/javascript" src="/kpi_dashboard_altair/static/lib/vega/vega-lite.min.js"/> |
|||
<script type="text/javascript" src="/kpi_dashboard_altair/static/lib/vega/vega-embed.min.js"/> |
|||
<script type="text/javascript" src="/kpi_dashboard_altair/static/src/js/altair_widget.js"/> |
|||
</xpath> |
|||
</template> |
|||
</odoo> |
|||
@ -1,2 +1,3 @@ |
|||
altair |
|||
py3o.template |
|||
py3o.formats |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue