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.

151 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. Note: The order of axis values depends on their order in the matrix you provide.
  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. You can pass the following parameters:
  34. field_x_axis
  35. The field that indicates the x value of a point
  36. field_y_axis
  37. The field that indicates the y value of a point
  38. x_axis_clickable
  39. It indicates if the X axis allows to be clicked for navigating to the field
  40. (if it's a many2one field). True by default
  41. y_axis_clickable
  42. It indicates if the Y axis allows to be clicked for navigating to the field
  43. (if it's a many2one field). True by default
  44. field_label_x_axis
  45. Use another field to display in the table header
  46. field_label_y_axis
  47. Use another field to display in the table header
  48. field_value
  49. Show this field as value
  50. show_row_totals
  51. If field_value is a numeric field, calculate row totals
  52. show_column_totals
  53. If field_value is a numeric field, calculate column totals
  54. field_att_<name>
  55. Declare as many options prefixed with this string as you need for binding
  56. a field value with an HTML node attribute (disabled, class, style...)
  57. called as the `<name>` passed in the option.
  58. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  59. :alt: Try me on Runbot
  60. :target: https://runbot.odoo-community.org/runbot/162/8.0
  61. Example
  62. =======
  63. You need a data structure already filled with values. Let's assume we want to
  64. use this widget in a wizard that lets the user fill in planned hours for one
  65. task per project per user. In this case, we can use ``project.task`` as our
  66. data model and point to it from our wizard. The crucial part is that we fill
  67. the field in the default function::
  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, {'project_id': p.id, 'user_id': u.id, 'planned_hours': 0})
  78. # if the project doesn't have a task for the user, create a new one
  79. if not p.task_ids.filtered(lambda x: x.user_id == u) else
  80. # otherwise, return the task
  81. (4, p.task_ids.filtered(lambda x: x.user_id == u)[0].id)
  82. for p in projects
  83. for u in users
  84. ]
  85. task_ids = fields.Many2many('project.task', default=_default_task_ids)
  86. Now in our wizard, we can use::
  87. <field name="task_ids" widget="x2many_2d_matrix" field_x_axis="project_id" field_y_axis="user_id" field_value="planned_hours" />
  88. Note that all values in the matrix must exist, so you need to create them
  89. previously if not present, but you can control visually the editability of
  90. the fields in the matrix through `field_att_disabled` option with a control
  91. field.
  92. Known issues / Roadmap
  93. ======================
  94. * it would be worth trying to instantiate the proper field widget and let it render the input
  95. Bug Tracker
  96. ===========
  97. Bugs are tracked on `GitHub Issues
  98. <https://github.com/OCA/web/issues>`_. In case of trouble, please
  99. check there if your issue has already been reported. If you spotted it first,
  100. help us smashing it by providing a detailed and welcomed feedback.
  101. Credits
  102. =======
  103. Contributors
  104. ------------
  105. * Holger Brunn <hbrunn@therp.nl>
  106. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  107. Maintainer
  108. ----------
  109. .. image:: https://odoo-community.org/logo.png
  110. :alt: Odoo Community Association
  111. :target: https://odoo-community.org
  112. This module is maintained by the OCA.
  113. OCA, or the Odoo Community Association, is a nonprofit organization whose
  114. mission is to support the collaborative development of Odoo features and
  115. promote its widespread use.
  116. To contribute to this module, please visit https://odoo-community.org.