OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

101 lines
3.5 KiB

  1. ===================
  2. Kpi Dashboard Bokeh
  3. ===================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard_bokeh
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-kpi_dashboard_bokeh
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. Define KPI dashboard graphs using bokeh.
  25. **Table of contents**
  26. .. contents::
  27. :local:
  28. Configuration
  29. =============
  30. #. Access `Dashboards > Configuration > KPI Dashboards > Configure KPI`
  31. #. Create a new KPI specifying with widget type `bokeh`
  32. In order to define the value, you can must define a function like::
  33. from bokeh.plotting import figure
  34. from bokeh.embed import components
  35. def test_demo_bokeh(self):
  36. p = figure(width=1000, height=1000, sizing_mode="scale_both")
  37. # import that as `from bokeh.plotting import figure`
  38. p.line([0, 1, 2], [1, 10, random.random() * 10], line_width=5)
  39. # (...)
  40. # fill the record field with both markup and the script of a chart.
  41. script, div = components(p)
  42. return {"bokeh": "%s%s" % (div, script)}
  43. You can also use `code`. The following items will be added automatically to the
  44. code items:
  45. * `figure`
  46. * `components`
  47. * `simple_components`: Like components but adds a theme with no alpha background
  48. Bug Tracker
  49. ===========
  50. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  51. In case of trouble, please check there if your issue has already been reported.
  52. If you spotted it first, help us smashing it by providing a detailed and welcomed
  53. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20kpi_dashboard_bokeh%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  54. Do not contact contributors directly about support or help with technical issues.
  55. Credits
  56. =======
  57. Authors
  58. ~~~~~~~
  59. * Creu Blanca
  60. Contributors
  61. ~~~~~~~~~~~~
  62. * Enric Tobella <etobella@creublanca.es>
  63. Maintainers
  64. ~~~~~~~~~~~
  65. This module is maintained by the OCA.
  66. .. image:: https://odoo-community.org/logo.png
  67. :alt: Odoo Community Association
  68. :target: https://odoo-community.org
  69. OCA, or the Odoo Community Association, is a nonprofit organization whose
  70. mission is to support the collaborative development of Odoo features and
  71. promote its widespread use.
  72. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard_bokeh>`_ project on GitHub.
  73. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.