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.

103 lines
3.6 KiB

  1. Add Tiles to Dashboard
  2. ======================
  3. <<<<<<< HEAD
  4. module to give you a dashboard where you can configure tile from any view
  5. and add them as short cut.
  6. * Tile can be:
  7. * displayed only for a user;
  8. * global for all users (In that case, some tiles will be hidden if
  9. the current user doesn't have access to the given model);
  10. * The tile displays items count of a given model restricted to a given domain;
  11. * Optionnaly, the tile can display the result of a function of a field;
  12. * Function is one of sum/avg/min/max/median;
  13. * Field must be integer or float;
  14. =======
  15. Adds a dashboard where you can configure tiles from any view and add them as short cut.
  16. By default, the tile displays items count of a given model restricted to a given domain.
  17. Optionally, the tile can display the result of a function on a field.
  18. - Function is one of `sum`, `avg`, `min`, `max` or `median`.
  19. - Field must be integer or float.
  20. Tile can be:
  21. - Displayed only for a user.
  22. - Global for all users.
  23. - Restricted to some groups.
  24. *Note: The tile will be hidden if the current user doesn't have access to the given model.*
  25. >>>>>>> 3ab676d... [IMP][8.0][web_dashboard_tile] Refactor (see changes in description) (#476)
  26. Usage
  27. =====
  28. * Dashboad sample, displaying Sale Orders to invoice:
  29. .. image:: /web_dashboard_tile/static/src/img/screenshot_dashboard.png
  30. * Tree view displayed when user click on the tile:
  31. .. image:: /web_dashboard_tile/static/src/img/screenshot_action_click.png
  32. Known issues / Roadmap
  33. ======================
  34. <<<<<<< HEAD
  35. * Can not edit tile from dashboard (color, sequence, function, ...);
  36. * Context are ignored;
  37. * Date filter can not be relative;
  38. * Combine domain of menue and filter so can not restore origin filter;
  39. * Support context_today;
  40. * Add icons;
  41. * Support client side action (like inbox);
  42. =======
  43. Known issues
  44. ============
  45. * Can not edit tile from dashboard (color, sequence, function, ...).
  46. * Original context is ignored.
  47. * Original domain and filter are not restored.
  48. * To preserve a relative date domain, you have to manually edit the tile's domain from `Configuration > User Interface > Dashboard Tile`. You can use the same variables available in filters (`uid`, `context_today()`, `current_date`, `time`, `datetime`, `relativedelta`).
  49. Roadmap
  50. =======
  51. * Add icons.
  52. * Support client side action (like inbox).
  53. * Restore original Domain + Filter when an action is set.
  54. * Posibility to hide the tile based on a field expression.
  55. * Posibility to set the background color based on a field expression.
  56. >>>>>>> 3ab676d... [IMP][8.0][web_dashboard_tile] Refactor (see changes in description) (#476)
  57. Bug Tracker
  58. ===========
  59. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  60. In case of trouble, please check there if your issue has already been reported.
  61. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  62. `here <https://github.com/OCA/
  63. web/issues/new?body=module:%20
  64. web_dashboard_tile%0Aversion:%20
  65. 8.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  66. Credits
  67. =======
  68. Contributors
  69. ------------
  70. * Markus Schneider <markus.schneider at initos.com>
  71. * Sylvain Le Gal (https://twitter.com/legalsylvain)
  72. Maintainer
  73. ----------
  74. .. image:: http://odoo-community.org/logo.png
  75. :alt: Odoo Community Association
  76. :target: http://odoo-community.org
  77. This module is maintained by the OCA.
  78. 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.
  79. To contribute to this module, please visit http://odoo-community.org.