This module allows to show an x2many field with 3-tuples ($x_value, $y_value, $value) in a table
where value(n/n) is editable.
An example use case would be: Select some projects and some employees so that a manager can easily fill in the planned_hours for one task per employee. The result could look like this:
The beauty of this is that you have an arbitrary amount of columns with this widget, trying to get this in standard x2many lists involves some quite ugly hacks. Note: The order of axis values depends on their order in the matrix you provide.
Use this widget by saying:
<field name="my_field" widget="x2many_2d_matrix" />
This assumes that my_field refers to a model with the fields x, y and value. If your fields are named differently, pass the correct names as attributes:
<field name="my_field" widget="x2many_2d_matrix" field_x_axis="my_field1" field_y_axis="my_field2" field_value="my_field3" />
You can pass the following parameters:
- field_x_axis
- The field that indicates the x value of a point
- field_y_axis
- The field that indicates the y value of a point
- x_axis_clickable
- It indicates if the X axis allows to be clicked for navigating to the field (if it's a many2one field). True by default
- y_axis_clickable
- It indicates if the Y axis allows to be clicked for navigating to the field (if it's a many2one field). True by default
- field_label_x_axis
- Use another field to display in the table header
- field_label_y_axis
- Use another field to display in the table header
- field_value
- Show this field as value
- show_row_totals
- If field_value is a numeric field, calculate row totals
- show_column_totals
- If field_value is a numeric field, calculate column totals
- field_att_<name>
- Declare as many options prefixed with this string as you need for binding a field value with an HTML node attribute (disabled, class, style...) called as the <name> passed in the option.
You need a data structure already filled with values. Let's assume we want to
use this widget in a wizard that lets the user fill in planned hours for one
task per project per user. In this case, we can use project.task as our
data model and point to it from our wizard. The crucial part is that we fill
the field in the default function:
class MyWizard(models.TransientModel):
_name = 'my.wizard'
def _default_task_ids(self):
# your list of project should come from the context, some selection
# in a previous wizard or wherever else
projects = self.env['project.project'].browse([1, 2, 3])
# same with users
users = self.env['res.users'].browse([1, 2, 3])
return [
(0, 0, {'project_id': p.id, 'user_id': u.id, 'planned_hours': 0})
# if the project doesn't have a task for the user, create a new one
if not p.task_ids.filtered(lambda x: x.user_id == u) else
# otherwise, return the task
(4, p.task_ids.filtered(lambda x: x.user_id == u)[0].id)
for p in projects
for u in users
]
task_ids = fields.Many2many('project.task', default=_default_task_ids)
Now in our wizard, we can use:
<field name="task_ids" widget="x2many_2d_matrix" field_x_axis="project_id" field_y_axis="user_id" field_value="planned_hours" />
Note that all values in the matrix must exist, so you need to create them previously if not present, but you can control visually the editability of the fields in the matrix through field_att_disabled option with a control field.
- it would be worth trying to instantiate the proper field widget and let it render the input
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
- Holger Brunn <[email protected]>
- Pedro M. Baeza <[email protected]>
This module is maintained by the OCA.
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.
To contribute to this module, please visit https://odoo-community.org.