Skip to main content
Odoo Community Association

2D matrix for x2many fields

Production/Stable License: AGPL-3 OCA/web Translate me on Weblate Try me on Runboat

This module allows to show an x2many field with 3-tuples ($x_value, $y_value, $value) in a table

$x_value1

$x_value2

$y_value1

$value(1/1)

$value(2/1)

$y_value2

$value(1/2)

$value(2/2)

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:

Screenshot

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.

Table of contents

Usage

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">
    <list>
        <field name="my_field"/>
        <field name="my_field1"/>
        <field name="my_field2"/>
        <field name="my_field3"/>
    </list>
</field>

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

field_value Show this field as value

show_row_totals If field_value is a numeric field, it indicates if you want to calculate row totals. True by default

show_column_totals If field_value is a numeric field, it indicates if you want to calculate column totals. True by default

x_axis_clickable If the x axis field is a many2one field, render the values as links to the record in question

y_axis_clickable If the y axis field is a many2one field, render the values as links to the record in question

For the value field, you can set any attributes you’d set in a normal list view, ie if your value field is a many2one field and you want to disable creating records via this field, you’d write

<field name="my_field3" options="{'no_create': true}"/>

or if you want to have a custom domain or context

<field name="my_field3" domain="[('some_field', '=', my_field1)]" context="{'default_some_field': my_field1}" />

Note that to be able to refer to other fields than the ones used as coordinates or value, you have to add them inside the list node.

Example

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:

from odoo import fields, models

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, {
                'name': 'Sample task name',
                'project_id': p.id,
                'user_id': u.id,
                'planned_hours': 0,
                'message_needaction': False,
                'date_deadline': fields.Date.today(),
            })
            # 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">
    <list>
        <field name="task_ids"/>
        <field name="project_id"/>
        <field name="user_id"/>
        <field name="planned_hours"/>
    </list>
</field>

Known issues / Roadmap

Changelog

12.0.1.0.1 (2018-12-07)

  • [FIX] Cells are unable to render property. (#1126)

12.0.1.0.0 (2018-11-20)

  • [12.0][MIG] web_widget_x2many_2d_matrix (#1101)

Bug Tracker

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 to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Hunki Enterprises BV

  • Therp BV

  • Tecnativa

  • Camptocamp

  • CorporateHub

  • Onestein

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Current maintainers:

JasminSForgeFlow DavidJForgeFlow hbrunn

This module is part of the OCA/web project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Release files for odoo-addon-web-widget-x2many-2d-matrix 19.0.1.0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-web-widget-x2many-2d-matrix 19.0.1.0.0.2
File Interpreter ABI Platform
odoo_addon_web_widget_x2many_2d_matrix-19.0.1.0.0.2-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_web_widget_x2many_2d_matrix-19.0.1.0.0.2-py3-none-any.whl

Download URL odoo_addon_web_widget_x2many_2d_matrix-19.0.1.0.0.2-py3-none-any.whl
Size 68.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e5f1d79c29f8977af81432b33229c18a7bde8c20811ce588d3663cfc19811fcd
BLAKE2b-256 checksum
How to use checksums
d19a94b0813295251f2fadeb5406e0eaa59c04e54cc4033a7b898a116ca2c07c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release history Release notifications | RSS feed

This release

19.0.1.0.0.2 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page