Kpi Dashboard Altair

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

Define KPI graphs using altair

Table of contents

Configuration

Configure KPIs

  1. Access Dashboards > Configuration > KPI Dashboards > Configure KPI
  2. 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.

https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/config.png

Usage

https://raw.githubusercontent.com/OCA/reporting-engine/12.0/kpi_dashboard_altair/static/description/graph.png

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 smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Creu Blanca

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 maintainer:

etobella

This module is part of the OCA/reporting-engine project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.