Author: |
Creu Blanca,Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
12.0 |
Repository: |
aaltinisik/reporting-engine |
Dependencies: |
kpi_dashboard,
and
web |
Languages: |
HTML (371, 64.0%),
JavaScript (42, 7.2%),
Python (39, 6.7%),
XML (51, 8.8%),
and
reStructuredText (77, 13.3%) |
Other repositories: |
AITIC/reporting-engine,
Change2improve/reporting-engine,
Comunitea/reporting-engine,
DamonLiu0814/reporting-engine,
Darknroses/reporting-engine,
Digital5-Odoo/reporting-engine,
Dobtor-OCA/reporting-engine,
EBII/reporting-engine,
ERPLibre/reporting-engine,
ForgeFlow/reporting-engine,
Ingeos/reporting-engine,
Jarsa/reporting-engine,
NeatNerdPrime/reporting-engine,
NextERP-Romania/reporting-engine,
Nubeo-be/reporting-engine,
OCA-MUK/reporting-engine,
OCA/reporting-engine,
Rad0van/reporting-engine,
SimoRubi/reporting-engine,
Studio73/reporting-engine,
Syci-Consulting/reporting-engine,
Tecnativa/reporting-engine,
Vauxoo/reporting-engine,
acsone/reporting-engine,
akretion/reporting-engine,
anhvu-sg/reporting-engine,
aurestic/reporting-engine,
blooparksystems/reporting-engine,
brain-tec/reporting-engine,
budisentosa/reporting-engine,
coopiteasy/reporting-engine,
druidoo-dev/reporting-engine,
ecosoft-odoo/reporting-engine,
flachica/reporting-engine,
gbertolani/reporting-engine,
goyugo/reporting-engine,
initOS/reporting-engine,
johnbendi/reporting-engine,
kmee/reporting-engine,
legalsylvain/reporting-engine,
lideritjnma/reporting-engine,
lweiming/reporting-engine,
multidadosti-erp/reporting-engine,
oondeo/reporting-engine,
praxigento/oca-reporting-engine,
robertsvx27/reporting-engine,
sacostaylara/reporting-engine,
sanube/reporting-engine,
sendalpegat/reporting-engine,
sergiocorato/reporting-engine,
sgheller/reporting-engine,
sunflowerit/reporting-engine,
suwatuanp/reporting-engine,
syci/reporting-engine,
takinobori/oca-reporting-engine,
tbaden/reporting-engine,
tegin/reporting-engine,
tirma-sa/reporting-engine,
ursais/reporting-engine,
versada/reporting-engine,
vikichavada/reporting-engine,
and
zhaohuaw/reporting-engine |
<h1 class="title">Kpi Dashboard Altair</h1>
<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></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="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2 class="with-subtitle"><a class="toc-backref" href="#id1">Configuration</a></h2>
<h2 class="section-subtitle" id="configure-kpis"><span class="section-subtitle">Configure KPIs</span></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>
<code>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())}</code>
</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>
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png" />
<a name="usage"></a>
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png" />
</div>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id4">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id5">Authors</a></h3>
<ul class="simple">
<li>Creu Blanca</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<ul class="simple">
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id7">Maintainers</a></h3>
<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>