Skip to main content

Create dashboards using altair

Project description

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

Contributors

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file odoo12_addon_kpi_dashboard_altair-12.0.1.0.3.99.dev2-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo12_addon_kpi_dashboard_altair-12.0.1.0.3.99.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 84120317196b5a7f09c30ccdf73e8e9bb6215866710e6f6b8806c0b463c2b469
MD5 308bbfe565ee5de1b6b56d6bfb9239f3
BLAKE2b-256 66bc9c866f7d0b553624c4581fe943c52efc790ef9b12b870b066fc79a7ba292

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page