124 lines
3.9 KiB
ReStructuredText
124 lines
3.9 KiB
ReStructuredText
====================
|
|
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.
|
|
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png
|
|
|
|
|
|
Usage
|
|
=====
|
|
|
|
|
|
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png
|
|
|
|
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.
|