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.

150 lines
5.1 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. $y_value2 $value(1/2) $value(2/2)
  14. ========= =========== ===========
  15. where `value(n/n)` is editable.
  16. An example use case would be: Select some projects and some employees so that
  17. a manager can easily fill in the planned_hours for one task per employee. The
  18. result could look like this:
  19. .. image:: /web_widget_x2many_2d_matrix/static/description/screenshot.png
  20. :alt: Screenshot
  21. The beauty of this is that you have an arbitrary amount of columns with this
  22. widget, trying to get this in standard x2many lists involves some quite ugly
  23. hacks.
  24. Usage
  25. =====
  26. Use this widget by saying::
  27. <field name="my_field" widget="x2many_2d_matrix" />
  28. This assumes that my_field refers to a model with the fields `x`, `y` and
  29. `value`. If your fields are named differently, pass the correct names as
  30. attributes::
  31. <field name="my_field" widget="x2many_2d_matrix" field_x_axis="my_field1" field_y_axis="my_field2" field_value="my_field3" />
  32. You can pass the following parameters:
  33. field_x_axis
  34. The field that indicates the x value of a point
  35. field_y_axis
  36. The field that indicates the y value of a point
  37. x_axis_clickable
  38. It indicates if the X axis allows to be clicked for navigating to the field
  39. (if it's a many2one field). True by default
  40. y_axis_clickable
  41. It indicates if the Y axis allows to be clicked for navigating to the field
  42. (if it's a many2one field). True by default
  43. field_label_x_axis
  44. Use another field to display in the table header
  45. field_label_y_axis
  46. Use another field to display in the table header
  47. field_value
  48. Show this field as value
  49. show_row_totals
  50. If field_value is a numeric field, calculate row totals
  51. show_column_totals
  52. If field_value is a numeric field, calculate column totals
  53. field_att_<name>
  54. Declare as many options prefixed with this string as you need for binding
  55. a field value with an HTML node attribute (disabled, class, style...)
  56. called as the `<name>` passed in the option.
  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/8.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. class MyWizard(models.TransientModel):
  68. _name = 'my.wizard'
  69. def _default_task_ids(self):
  70. # your list of project should come from the context, some selection
  71. # in a previous wizard or wherever else
  72. projects = self.env['project.project'].browse([1, 2, 3])
  73. # same with users
  74. users = self.env['res.users'].browse([1, 2, 3])
  75. return [
  76. (0, 0, {'project_id': p.id, 'user_id': u.id, 'planned_hours': 0})
  77. # if the project doesn't have a task for the user, create a new one
  78. if not p.task_ids.filtered(lambda x: x.user_id == u) else
  79. # otherwise, return the task
  80. (4, p.task_ids.filtered(lambda x: x.user_id == u)[0].id)
  81. for p in projects
  82. for u in users
  83. ]
  84. task_ids = fields.Many2many('project.task', default=_default_task_ids)
  85. Now in our wizard, we can use::
  86. <field name="task_ids" widget="x2many_2d_matrix" field_x_axis="project_id" field_y_axis="user_id" field_value="planned_hours" />
  87. Note that all values in the matrix must exist, so you need to create them
  88. previously if not present, but you can control visually the editability of
  89. the fields in the matrix through `field_att_disabled` option with a control
  90. field.
  91. Known issues / Roadmap
  92. ======================
  93. * it would be worth trying to instantiate the proper field widget and let it render the input
  94. Bug Tracker
  95. ===========
  96. Bugs are tracked on `GitHub Issues
  97. <https://github.com/OCA/web/issues>`_. In case of trouble, please
  98. check there if your issue has already been reported. If you spotted it first,
  99. help us smashing it by providing a detailed and welcomed feedback.
  100. Credits
  101. =======
  102. Contributors
  103. ------------
  104. * Holger Brunn <hbrunn@therp.nl>
  105. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  106. Maintainer
  107. ----------
  108. .. image:: https://odoo-community.org/logo.png
  109. :alt: Odoo Community Association
  110. :target: https://odoo-community.org
  111. This module is maintained by the OCA.
  112. OCA, or the Odoo Community Association, is a nonprofit organization whose
  113. mission is to support the collaborative development of Odoo features and
  114. promote its widespread use.
  115. To contribute to this module, please visit https://odoo-community.org.