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.

172 lines
5.5 KiB

10 years ago
10 years ago
10 years ago
  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ===========================
  5. 2D matrix for x2many fields
  6. ===========================
  7. This module allows to show an x2many field with 3-tuples
  8. ($x_value, $y_value, $value) in a table
  9. +-----------+-------------+-------------+
  10. | | $x_value1 | $x_value2 |
  11. +===========+=============+=============+
  12. | $y_value1 | $value(1/1) | $value(2/1) |
  13. +-----------+-------------+-------------+
  14. | $y_value2 | $value(1/2) | $value(2/2) |
  15. +-----------+-------------+-------------+
  16. where `value(n/n)` is editable.
  17. An example use case would be: Select some projects and some employees so that
  18. a manager can easily fill in the planned_hours for one task per employee. The
  19. result could look like this:
  20. .. image:: /web_widget_x2many_2d_matrix/static/description/screenshot.png
  21. :alt: Screenshot
  22. The beauty of this is that you have an arbitrary amount of columns with this
  23. widget, trying to get this in standard x2many lists involves some quite ugly
  24. hacks.
  25. Usage
  26. =====
  27. Use this widget by saying::
  28. <field name="my_field" widget="x2many_2d_matrix" />
  29. This assumes that my_field refers to a model with the fields `x`, `y` and
  30. `value`. If your fields are named differently, pass the correct names as
  31. attributes::
  32. <field name="my_field" widget="x2many_2d_matrix" field_x_axis="my_field1" field_y_axis="my_field2" field_value="my_field3">
  33. <tree>
  34. <field name="my_field"/>
  35. <field name="my_field1"/>
  36. <field name="my_field2"/>
  37. <field name="my_field3"/>
  38. </tree>
  39. </field>
  40. You can pass the following parameters:
  41. field_x_axis
  42. The field that indicates the x value of a point
  43. field_y_axis
  44. The field that indicates the y value of a point
  45. field_label_x_axis
  46. Use another field to display in the table header
  47. field_label_y_axis
  48. Use another field to display in the table header
  49. field_value
  50. Show this field as value
  51. show_row_totals
  52. If field_value is a numeric field, it indicates if you want to calculate
  53. row totals. True by default
  54. show_column_totals
  55. If field_value is a numeric field, it indicates if you want to calculate
  56. column totals. True by default
  57. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  58. :alt: Try me on Runbot
  59. :target: https://runbot.odoo-community.org/runbot/162/11.0
  60. Example
  61. =======
  62. You need a data structure already filled with values. Let's assume we want to
  63. use this widget in a wizard that lets the user fill in planned hours for one
  64. task per project per user. In this case, we can use ``project.task`` as our
  65. data model and point to it from our wizard. The crucial part is that we fill
  66. the field in the default function::
  67. from odoo import fields, models
  68. class MyWizard(models.TransientModel):
  69. _name = 'my.wizard'
  70. def _default_task_ids(self):
  71. # your list of project should come from the context, some selection
  72. # in a previous wizard or wherever else
  73. projects = self.env['project.project'].browse([1, 2, 3])
  74. # same with users
  75. users = self.env['res.users'].browse([1, 2, 3])
  76. return [
  77. (0, 0, {
  78. 'name': 'Sample task name',
  79. 'project_id': p.id,
  80. 'user_id': u.id,
  81. 'planned_hours': 0,
  82. 'message_needaction': False,
  83. 'date_deadline': fields.Date.today(),
  84. })
  85. # if the project doesn't have a task for the user, create a new one
  86. if not p.task_ids.filtered(lambda x: x.user_id == u) else
  87. # otherwise, return the task
  88. (4, p.task_ids.filtered(lambda x: x.user_id == u)[0].id)
  89. for p in projects
  90. for u in users
  91. ]
  92. task_ids = fields.Many2many('project.task', default=_default_task_ids)
  93. Now in our wizard, we can use::
  94. <field name="task_ids" widget="x2many_2d_matrix" field_x_axis="project_id" field_y_axis="user_id" field_value="planned_hours">
  95. <tree>
  96. <field name="task_ids"/>
  97. <field name="project_id"/>
  98. <field name="user_id"/>
  99. <field name="planned_hours"/>
  100. </tree>
  101. </field>
  102. Known issues / Roadmap
  103. ======================
  104. * Support extra attributes on each field cell via `field_extra_attrs` param.
  105. We could set a cell as not editable, required or readonly for instance.
  106. The `readonly` case will also give the ability
  107. to click on m2o to open related records.
  108. * Support limit total records in the matrix. Ref: https://github.com/OCA/web/issues/901
  109. Bug Tracker
  110. ===========
  111. Bugs are tracked on `GitHub Issues
  112. <https://github.com/OCA/web/issues>`_. In case of trouble, please
  113. check there if your issue has already been reported. If you spotted it first,
  114. help us smash it by providing a detailed and welcomed feedback.
  115. Credits
  116. =======
  117. Contributors
  118. ------------
  119. * Holger Brunn <hbrunn@therp.nl>
  120. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  121. * Artem Kostyuk <a.kostyuk@mobilunity.com>
  122. * Simone Orsi <simone.orsi@camptocamp.com>
  123. * Timon Tschanz <timon.tschanz@camptocamp.com>
  124. Maintainer
  125. ----------
  126. .. image:: https://odoo-community.org/logo.png
  127. :alt: Odoo Community Association
  128. :target: https://odoo-community.org
  129. This module is maintained by the OCA.
  130. OCA, or the Odoo Community Association, is a nonprofit organization whose
  131. mission is to support the collaborative development of Odoo features and
  132. promote its widespread use.
  133. To contribute to this module, please visit https://odoo-community.org.