Views

Views are what define how records should be displayed to end-users. They are specified in XML which means that they can be edited independently from the models that they represent. They are flexible and allow a high level of customization of the screens that they control. There exist various types of views. Each of them represents a mode of visualization: form, list, kanban, etc.

Generic structure

Basic views generally share the common structure defined below. Placeholders are denoted in all caps.

<record id="MODEL_view_TYPE" model="ir.ui.view">
  <field name="name">NAME</field>
  <field name="model">MODEL</field>
  <field name="arch" type="xml">
    <VIEW_TYPE>
      <VIEW_SPECIFICATIONS/>
    </VIEW_TYPE>
  </field>
</record>

Fields

View objects expose a number of fields. They are optional unless specified otherwise.

  • name (mandatory) Char

    Only useful as a mnemonic/description of the view when looking for one in a list of some sort.

  • model Char

    The model linked to the view, if applicable.

  • priority Integer

    When a view is requested by (model, type), the view matching the model and the type, with the lowest priority will be returned (it is the default view).

    It also defines the order of views application during view inheritance.

  • groups_id Many2many -> odoo.addons.base.models.res_users.Groups

    The groups allowed to use/access the current view.

    If the view extends an existing view, the extension will only be applied for a given user if the user has access to the provided groups_id.

  • arch Text

    The description of the view layout.

Attributes

The different view types have a wide variety of attributes allowing customizations of the generic behaviors. Some main attributes will be explained here. They do not all have an impact on all view types.

注解

The current context and user access rights may also impact the view abilities.

  • create

    Disable/enable record creation on the view.

  • edit (form & list & gantt)

    Disable/enable record editing on the view.

  • delete (form & list)

    Disable/enable record deletion on the view through the Action dropdown.

  • duplicate (form)

    Disable/enable record duplication on the view through the Action dropdown.

  • decoration-{$name} (list & gantt)

    Define a conditional display of a record in the style of a row’s text based on the corresponding record’s attributes.

    Values are Python expressions. For each record, the expression is evaluated with the record’s attributes as context values and if true, the corresponding style is applied to the row. Here are some of the other values available in the context:

    • uid: the id of the current user,

    • today: the current local date as a string of the form YYYY-MM-DD,

    • now: same as today with the addition of the current time. This value is formatted as YYYY-MM-DD hh:mm:ss.

    <tree decoration-info="state == 'draft'"
    decoration-danger="state == 'help_needed'"
    decoration-bf="state='busy'">
    <!-- TREE_VIEW_CONTENT -->
</tree>

    警告

    Supported values differ for the two view types. The Gantt view only supports success, info, warning, danger and secondary displays. The list view supports bf, it, success, info, warning, danger, muted and primary displays.

  • sample (kanban & list & gantt & graph & pivot & cohort)

    Populate the view with a set of sample records if none are found for the current model. This attribute is false by default.

    These fake records will have heuristics for certain field names/models. For example, a field ‘display_name’ on the model ‘res.users’ will be populated with sample people names while an ‘email’ field will be in the form ‘firstname.lastname@sample.demo’.

    The user will not be able to interact with these data and they will be discarded as soon as an action is performed (record created, column added, etc.)

  • banner_route a route address to be fetched and prepended to the view.

    If this attribute is set, the controller route url will be fetched and displayed above the view. The json response from the controller should contain an “html” key.

    If the html contains a stylesheet <link> tag, it will be removed and appended to <head>.

    To interact with the backend you can use <a type=”action”> tags. Please take a look at the documentation of the _onActionClicked method of AbstractController (addons/web/static/src/js/views/abstract_controller.js) for more details.

    Only views extending AbstractView and AbstractController can use this attribute, like Form, Kanban, List, …

    Example:

    <tree banner_route="/module_name/hello" />

    class MyController(odoo.http.Controller):
    @http.route('/module_name/hello', auth='user', type='json')
    def hello(self):
        return {
            'html': """
                <div>
                    <link href="/module_name/static/src/css/banner.css"
                        rel="stylesheet">
                    <h1>hello, world</h1>
                </div> """
        }

Inheritance

Inheritance fields

The two following View fields are used to specify inherited views.

  • inherit_id Many2one

    the current view’s parent view, unset by default. Specify the parent using the ref attribute:

    <field name="inherit_id" ref="library.view_book_form"/>

  • mode Selection: extension / primary

    inheritance mode, extension by default if inherit_id is set, primary otherwise.

    An example of where you would want to override mode while using inherit_id is delegation inheritance. In that case your derived model will be separate from its parent and views matching with one won’t match with the other. Suppose you inherit from a view associated with the parent model and want to customize the derived view to show data from the derived model. The mode of the derived view needs to be set to primary, because it’s the base (and maybe only) view for that derived model. Otherwise the view matching rules won’t apply.

View matching

  • if a view is requested by (model, type), the view with the right model and type, mode=primary and the lowest priority is matched.

  • when a view is requested by id, if its mode is not primary its closest parent with mode primary is matched.

View resolution

Resolution generates the final arch for a requested/matched primary view:

  1. if the view has a parent, the parent is fully resolved then the current view’s inheritance specs are applied

  2. if the view has no parent, its arch is used as-is

  3. the current view’s children with mode extension are looked up and their inheritance specs are applied depth-first (a child view is applied, then its children, then its siblings)

The result of applying children views yields the final arch

Inheritance specs

Inheritance specs are comprised of an element locator, to match the inherited element in the parent view, and children element that will be used to modify the inherited element.

There are three types of element locators for matching a target element:

  • An xpath element with an expr attribute. expr is an XPath expression1 applied to the current arch, the first node it finds is the match

  • a field element with a name attribute, matches the first field with the same name. All other attributes are ignored during matching

  • any other element: the first element with the same name and identical attributes (ignoring position and version attributes) is matched

<xpath expr="page[@name='pg']/group[@name='gp']/field" position="inside">
  <field name="description"/>
</xpath>

<field name="res_id" position="after"/>

<div name="name" position="replace">
  <div name="name2">
    <field name="name2"/>
  </div>
</div>

The inheritance spec may have an optional position attribute specifying how the matched node should be altered:

inside (default)

the content of the inheritance spec is appended to the matched node

replace

the content of the inheritance spec replaces the matched node. Any text node containing only $0 within the contents of the spec will be replaced by a complete copy of the matched node, effectively wrapping the matched node.

after

the content of the inheritance spec is added to the matched node’s parent, after the matched node

before

the content of the inheritance spec is added to the matched node’s parent, before the matched node

attributes

the content of the inheritance spec should be attribute elements with a name attribute and an optional body:

  • if the attribute element has a body, a new attributed named after its name is created on the matched node with the attribute element’s text as value

  • if the attribute element has no body, the attribute named after its name is removed from the matched node. If no such attribute exists, an error is raised

  • if the attribute element has an add attribute, a remove attribute, or both, the value of the matched node’s attribute named after name is recomputed to include the value(s) of add (separated by separator) and delete the value(s) of remove (separated by separator). If separator is not provided, , is used instead.

<field name="sale_information" position="attributes">
  <attribute name="invisible">0</attribute>
  <attribute name="attrs">
    {'invisible': [('sale_ok', '=', False)], 'readonly': [('editable', '=', False)]}
  </attribute>
  <attribute name="class" add="mt-1 mb-1" remove="mt-2 mb-2" separator=" "/>
</field>
move

can be used as a direct child of a inheritance spec with a inside, replace, after or before position attribute to move a node.

<xpath expr="//@target" position="after">
    <xpath expr="//@node" position="move"/>
</xpath>

<field name="target_field" position="after">
    <field name="my_field" position="move"/>
</field>

A view’s specs are applied sequentially.

1

an extension function is added for simpler matching in QWeb views: hasclass(*classes) matches if the context node has all the specified classes

Model Commons

Attributes

Methods

View types

Activity

The Activity view is used to display the activities linked to the records. The data are displayed in a chart with the records forming the rows and the activity types the columns. The first cell of each row displays a (customizable, see templates, quite similarly to Kanban) card representing the corresponding record. When clicking on others cells, a detailed description of all activities of the same type for the record is displayed.

警告

The Activity view is only available when the mail module is installed, and for the models that inherit from the mail.activity.mixin.

The root element of the Activity view is <activity>, it accepts the following attributes:

string (mandatory)

A title, which should describe the view

Possible children of the view element are:

field

declares fields to use in activity logic. If the field is simply displayed in the activity view, it does not need to be pre-declared.

Possible attributes are:

name (required)

the name of the field to fetch

templates

defines the QWeb Templates templates. Cards definition may be split into multiple templates for clarity, but activity views must define at least one root template activity-box, which will be rendered once for each record.

The activity view uses mostly-standard javascript qweb and provides the following context variables (see Kanban for more details):

widget

the current ActivityRecord(), can be used to fetch some meta-information. These methods are also available directly in the template context and don’t need to be accessed via widget

record

an object with all the requested fields as its attributes. Each field has two attributes value and raw_value

Calendar

Calendar views display records as events in a daily, weekly, monthly or yearly calendar.

注解

By default the calendar view will be centered around the current date (today). You can pass a specific initial date to the context of the action in order to set the initial focus of the calendar on the period (see mode) around this date (the context key to use being initial_date)

Their root element is <calendar>. Available attributes on the calendar view are:

date_start (required)

name of the record’s field holding the start date for the event

date_stop

name of the record’s field holding the end date for the event, if date_stop is provided records become movable (via drag and drop) directly in the calendar

date_delay

alternative to date_stop, provides the duration of the event instead of its end date (unit: day)

color

name of a record field to use for color segmentation. Records in the same color segment are allocated the same highlight color in the calendar, colors are allocated semi-randomly. Displayed the display_name/avatar of the visible record in the sidebar

form_view_id

view to open when the user create or edit an event. Note that if this attribute is not set, the calendar view will fall back to the id of the form view in the current action, if any.

event_open_popup

If the option ‘event_open_popup’ is set to true, then the calendar view will open events (or records) in a FormViewDialog. Otherwise, it will open events in a new form view (with a do_action)

quick_add

enables quick-event creation on click: only asks the user for a name (the field to which this values is saved can be controlled through rec_name) and tries to create a new event with just that and the clicked event time. Falls back to a full form dialog if the quick creation fails

create_name_field

name of the record’s field holding the textual representation of the record, this is used when creating records through the ‘quick create’ mechanism

all_day

name of a boolean field on the record indicating whether the corresponding event is flagged as day-long (and duration is irrelevant)

mode

Default display mode when loading the calendar. Possible attributes are: day, week, month, year

scales

Comma-separated list of scales to provide. By default, all scales are available. See mode for possible scale values.

create, delete

allows disabling the corresponding action in the view by setting the corresponding attribute to false

<field>

declares fields to aggregate or to use in kanban logic. If the field is simply displayed in the calendar cards.

Fields can have additional attributes:

invisible

use “True” to hide the value in the cards

avatar_field

only for x2many field, to display the avatar instead of the display_name in the cards

write_model and write_field and filter_field

you can add a filter and save the result in the defined model, the filter is added in the sidebar. The filter_field is optional and allows you to specify the field that will hold the status of the filter.

filters and color

use “True” to add this field in filter in the sidebar. You can specify a color field used to colorize the checkbox.

Cohort

Enterprise feature

The cohort view is used to display and understand the way some data changes over a period of time. For example, imagine that for a given business, clients can subscribe to some service. The cohort view can then display the total number of subscriptions each month, and study the rate at which client leave the service (churn). When clicking on a cell, the cohort view will redirect you to a new action in which you will only see the records contained in the cell’s time interval; this action contains a list view and a form view.

注解

By default the cohort view will use the same list and form views as those defined on the action. You can pass a list view and a form view to the context of the action in order to set/override the views that will be used (the context keys to use being form_view_id and list_view_id)

For example, here is a very simple cohort view:

<cohort string="Subscription" date_start="date_start" date_stop="date" interval="month"/>

The root element of the Cohort view is <cohort>, it accepts the following attributes:

string (mandatory)

A title, which should describe the view

date_start (mandatory)

A valid date or datetime field. This field is understood by the view as the beginning date of a record

date_stop (mandatory)

A valid date or datetime field. This field is understood by the view as the end date of a record. This is the field that will determine the churn.

mode (optional)

A string to describe the mode. It should be either ‘churn’ or ‘retention’ (default). Churn mode will start at 0% and accumulate over time whereas retention will start at 100% and decrease over time.

timeline (optional)

A string to describe the timeline. It should be either ‘backward’ or ‘forward’ (default). Forward timeline will display data from date_start to date_stop, whereas backward timeline will display data from date_stop to date_start (when the date_start is in future / greater than date_stop).

interval (optional)

A string to describe a time interval. It should be ‘day’, ‘week’, ‘month’’ (default) or ‘year’.

measure (optional)

A field that can be aggregated. This field will be used to compute the values for each cell. If not set, the cohort view will count the number of occurrences.

<field> (optional)

allows to specify a particular field in order to manage it from the available measures, it’s main use is for hiding a field from the selectable measures:

name (mandatory)

the name of the field to use in the view.

string (optional)

the name that would be used to display the field in the cohort view, overrides the default python String attribute of the field.

invisible (optional)

if true, the field will not appear either in the active measures nor in the selectable measures (useful for fields that do not make sense aggregated, such as fields in different units, e.g. € and $).

Form

Form views are used to display the data from a single record. Their root element is <form>. They are composed of regular HTML with additional structural and semantic components.

Structural components

Structural components provide structure or “visual” features with little logic. They are used as elements or sets of elements in form views.

notebook

defines a tabbed section. Each tab is defined through a page child element. Pages can have the following attributes:

string (required)

the title of the tab

accesskey

an HTML accesskey

attrs

standard dynamic attributes based on record values

注解

Note that notebook should not be placed within group

group

used to define column layouts in forms. By default, groups define 2 columns and most direct children of groups take a single column. field direct children of groups display a label by default, and the label and the field itself have a colspan of 1 each.

The number of columns in a group can be customized using the col attribute, the number of columns taken by an element can be customized using colspan.

Children are laid out horizontally (tries to fill the next column before changing row).

Groups can have a string attribute, which is displayed as the group’s title

newline

only useful within group elements, ends the current row early and immediately switches to a new row (without filling any remaining column beforehand)

separator

small horizontal spacing, with a string attribute behaves as a section title

sheet

can be used as a direct child to form for a narrower and more responsive form layout

header

combined with sheet, provides a full-width location above the sheet itself, generally used to display workflow buttons and status widgets

Semantic components

Semantic components tie into and allow interaction with the Odoo system. Available semantic components are:

button

call into the Odoo system, similar to list view buttons. In addition, the following attribute can be specified:

special

for form views opened in dialogs: save to save the record and close the dialog, cancel to close the dialog without saving.

confirm

confirmation message to display (and for the user to accept) before performing the button’s Odoo call (also works in Kanban views).

field

renders (and allow editing of, possibly) a single field of the current record. Using several times a field in a form view is supported and the fields can receive different values for modifiers ‘invisible’ and ‘readonly’. However, the behavior is not guaranteed when several fields exist with different values for modifier ‘required’. Possible attributes of the field node are:

name (mandatory)

the name of the field to render

id

the node id. Useful when there are several occurrences of the same field in the view (see label component below). Default is the field name.

widget

fields have a default rendering based on their type (e.g. Char, Many2one). The widget attributes allows using a different rendering method and context.

options

JSON object specifying configuration option for the field’s widget (including default widgets)

class

HTML class to set on the generated element, common field classes are:

oe_inline

prevent the usual line break following fields and limit their span.

oe_left, oe_right

floats the field to the corresponding direction

oe_read_only, oe_edit_only

only displays the field in the corresponding form mode

oe_avatar

for image fields, displays images as “avatar” (square, 90x90 maximum size, some image decorations)

groups

only displays the field for specific users

on_change

calls the specified method when this field’s value is edited, can generate update other fields or display warnings for the user

8.0 版后已移除: Use odoo.api.onchange() on the model

attrs

dynamic meta-parameters based on record values

domain

for relational fields only, filters to apply when displaying existing records for selection

context

for relational fields only, context to pass when fetching possible values

readonly

display the field in both readonly and edit mode, but never make it editable

required

generates an error and prevents saving the record if the field doesn’t have a value

nolabel

don’t automatically display the field’s label, only makes sense if the field is a direct child of a group element

placeholder

help message to display in empty fields. Can replace field labels in complex forms. Should not be an example of data as users are liable to confuse placeholder text with filled fields

mode

for One2many, display mode (view type) to use for the field’s linked records. One of tree, form, kanban or graph. The default is tree (a list display)

help

tooltip displayed for users when hovering the field or its label

filename

for binary fields, name of the related field providing the name of the file

password

indicates that a Char field stores a password and that its data shouldn’t be displayed

kanban_view_ref

for opening specific kanban view when selecting records from m2o/m2m in mobile environment

label

when a field component isn’t placed directly inside a group, or when its nolabel attribute is set, the field’s label isn’t automatically displayed alongside its value. The label component is the manual alternative of displaying the label of a field. Possible attributes are:

for (mandatory)

the reference to the field associated with the label. Can be either the name of a field, or its id (id attribute set on the field). When there are several occurrences of the same field in the view, and there are several label components associated with these field nodes, those labels must have unique for attributes (in this case referencing the id attribute of the corresponding field nodes).

string

the label to display. Display the field’s label (coming from the field definition in the model) by default.

class

same as for field component.

attrs

same as for field component.

Generic structure

<form>
  <header>
    <field name="state" widget="statusbar"/>
  </header>
  <sheet>
    <div class="oe_button_box">
      <BUTTONS/>
    </div>
    <group>
      <group>
        <field name="fname"/>
      </group>
    </group>
    <notebook>
      <page string="Page1">
        <group>
          <CONTENT/>
        </group>
      </page>
      <page string="Page2">
        <group>
          <CONTENT/>
        </group>
      </page>
    </notebook>
  </sheet>
</form>

Gantt

Enterprise feature

Gantt views appropriately display Gantt charts (for scheduling).

The root element of gantt views is <gantt/>, it has no children but can take the following attributes:

date_start (required)

name of the field providing the start datetime of the event for each record.

date_stop (required)

name of the field providing the end duration of the event for each record.

dependency_field

name of the many2many field that provides the dependency relation between two records. If B depends on A, dependency_field is the field that allows getting A from B. Both this field and dependency_inverted_field field are used to draw dependency arrows between pills and reschedule them.

dependency_inverted_field (required if dependency_field is provided)

name of the many2many field that provides the invert dependency relation than dependency_field. If B depends on A, dependency_inverted_field is the field that allows getting B from A.

color

name of the field used to color the pills according to its value

decoration-{$name}

allow changing the style of a row’s text based on the corresponding record’s attributes.

Values are Python expressions. For each record, the expression is evaluated with the record’s attributes as context values and if true, the corresponding style is applied to the row. Here are some of the other values available in the context:

  • uid: the id of the current user,

  • today: the current local date as a string of the form YYYY-MM-DD,

  • now: same as today with the addition of the current time. This value is formatted as YYYY-MM-DD hh:mm:ss.

{$name} can be one of the following bootstrap contextual color (danger, info, secondary, success or warning).

default_group_by

name of a field to group tasks by

disable_drag_drop

if set to true, the gantt view will not have any drag&drop support

consolidation

field name to display consolidation value in record cell

consolidation_max

dictionary with the “group by” field as key and the maximum consolidation value that can be reached before displaying the cell in red (e.g. {"user_id": 100})

consolidation_exclude

name of the field that describes if the task has to be excluded from the consolidation if set to true it displays a striped zone in the consolidation line

create, cell_create, edit, delete, plan

allows disabling the corresponding action in the view by setting the corresponding attribute to false (default: true).

  • create: If enabled, an Add button will be available in the control panel to create records.

  • cell_create: If enabled and create enabled, a “+” button will be displayed while hovering on a time slot cell to create a new record on that slot.

  • edit: If enabled, the opened records will be in edit mode (thus editable).

  • plan: If enabled and edit enabled, a “magnifying glass” button will be displayed on time slots to plan unassigned records into that time slot.

Example

When you do not want to create records on the gantt view and the beginning and end dates are required on the model, the planning feature should be disabled because no record will ever be found.

offset

Depending on the scale, the number of units to add to today to compute the default period. Examples: An offset of +1 in default_scale week will open the gantt view for next week, and an offset of -2 in default_scale month will open the gantt view of 2 months ago.

progress

name of a field providing the completion percentage for the record’s event, between 0 and 100

string

title of the gantt view

precision

JSON object specifying snapping precisions for the pills in each scale.

Possible values for scale day are (default: hour):

  • hour: records times snap to full hours (ex: 7:12 becomes 8:00)

  • hour:half: records times snap to half hours (ex: 7:12 becomes 7:30)

  • hour:quarter: records times snap to half hours (ex: 7:12 becomes 7:15)

Possible values for scale week are (default: day:half):

  • day: records times snap to full days (ex: 7:28 AM becomes 11:59:59 PM of the previous day, 10:32 PM becomes 12:00 PM of the current day)

  • day:half: records times snap to half hours (ex: 7:28 AM becomes 12:00 PM)

Possible values for scale month are (default: day:half):

  • day: records times snap to full days (ex: 7:28 AM becomes 11:59:59 PM of the previous day, 10:32 PM becomes 12:00 PM of the current day)

  • day:half: records times snap to half hours (ex: 7:28 AM becomes 12:00 PM)

Scale year always snap to full day.

Example of precision attribute: {"day": "hour:quarter", "week": "day:half", "month": "day"}

total_row

boolean to control whether the row containing the total count of records should be displayed. (default: false)

collapse_first_level

boolean to control whether it is possible to collapse each row if grouped by one field. (default: false, the collapse starts when grouping by two fields)

display_unavailability

boolean to mark the dates returned by the gantt_unavailability function of the model as available inside the gantt view. Records can still be scheduled in them, but their unavailability is visually displayed. (default: false)

default_scale

default scale when rendering the view. Possible values are (default: month):

  • day

  • week

  • month

  • year

scales

comma-separated list of allowed scales for this view. By default, all scales are allowed. For possible scale values to use in this list, see default_scale.

templates

defines the QWeb Templates template gantt-popover which is used when the user hovers over one of the records in the gantt view.

The gantt view uses mostly-standard javascript qweb and provides the following context variables:

widget

the current GanttRow(), can be used to fetch some meta-information. The getColor method to convert in a color integer is also available directly in the template context without using widget.

on_create

If specified when clicking the add button on the view, instead of opening a generic dialog, launch a client action. this should hold the xmlid of the action (eg: on_create="%(my_module.my_wizard)d"

form_view_id

view to open when the user create or edit a record. Note that if this attribute is not set, the gantt view will fall back to the id of the form view in the current action, if any.

dynamic_range

if set to true, the gantt view will start at the first record, instead of starting at the beginning of the year/month/day.

pill_label

If set to true, the time appears in the pill label when the scale is set on week or month. (e.g. 7:00 AM - 11:00 AM (4h) - DST Task 1)

thumbnails

This allows to display a thumbnail next to groups name if the group is a relationnal field. This expects a python dict which keys are the name of the field on the active model. Values are the names of the field holding the thumbnail on the related model.

Example: tasks have a field user_id that reference res.users. The res.users model has a field image that holds the avatar, then:

<gantt
   date_start="date_start"
   date_stop="date_stop"
   thumbnails="{'user_id': 'image_128'}"
 >
 </gantt>

will display the users avatars next to their names when grouped by user_id.

Graph

The graph view is used to visualize aggregations over a number of records or record groups. Its root element is <graph> which can take the following attributes:

type (optional)

one of bar (default), pie and line, the type of graph to use

stacked (optional)

only used for bar charts. Set to 0 to prevent the bars within a group to be stacked initially.

disable_linking (optional)

set to 1 to prevent from redirecting clicks on graph to list view

order (optional)

if set, x-axis values will be sorted by default according their measure with respect to the given order (asc or desc). Only used for bar and pie charts.

string (optional)

string displayed in the breadcrumbs when redirecting to list view.

The only allowed element within a graph view is field which can have the following attributes:

name (mandatory)

the name of a field to use in the view. If used for grouping (rather than aggregating)

invisible (optional)

if true, the field will not appear either in the active measures nor in the selectable measures.

type (optional)

if set to measure, the field will be used as an aggregated value within a group instead of a grouping criteria. It only works for the last field with that attribute but it is useful for other fields with string attribute (see below).

interval (optional)

on date and datetime fields, groups by the specified interval (day, week, month, quarter or year) instead of grouping on the specific datetime (fixed second resolution) or date (fixed day resolution). Default is month.

string (optional)

only used for field with type="measure". The name that will be used to display the field in the graph view, overrides the default python String attribute of the field.

The measures are automatically generated from the model fields; only the aggregatable fields are used. Those measures are also alphabetically sorted on the string of the field.

警告

graph view aggregations are performed on database content, non-stored function fields can not be used in graph views

Grid

Enterprise feature

Limitations

This view is a work in progress and may have to be expanded or altered.

  • only date column fields have been tested, selection and many2one are nominally implemented and supported but have not been tested, datetime is not implemented at all.

  • column cells are hardly configurable and must be numerical

  • cell adjustment is disabled by default and must be configured to be enabled

  • create, edit and delete ACL metadata doesn’t get automatically set on the view root due to limitations in fields_view_get post-processing (there’s a fixed explicit list of the view types getting those attributes)

Schema

The grid view has its own schema and additional validation in this module. The view architecture is:

<grid> (1)

architecture root element

  • mandatory string attribute

  • optional create, edit and delete attributes

  • optional adjustment and adjust_name attributes

    adjustment can be either object or action to indicate whether a cell’s adjustment should be performed through a method call or an action execution. adjust_name provides respectively the method name and the action id.

    In both cases, the adjustment parameters are provided as a grid_adjust context member, in the object case, the parameters are also provided as positional function parameters (next to an empty list of ids):

    row_domain

    the domain matching the entire row of the adjusted cell

    column_field

    the name of the column for the adjusted cell

    column_value

    the value of the column for the adjusted cell

    cell_field

    the measure field of the adjusted cell

    change

    the difference between the old value of the cell and the adjusted one, may be positive or negative

  • optional hide_line_total and hide_column_total attributes

    hide_line_total

    set to true to hide total line (default false)

    hide_column_total

    set to true to hide total column (default false)

  • optional barchart_total attribute

    barchart_total

    set to true in order to display a bar chart at the bottom of the grid, based on the totals of the columns (default false).

  • optional create_inline and display_empty attributes

    create_inline

    set to true in order to display an additional row at bottom of the grid with an Add a line button (default false). When this option is set to true, the Add a line button from the control panel is hidden. When no data is available and when display_empty is not set (so when the help content is displayed), the the Add a line button from the control panel is shown in order to let the user create a first record.

    display_empty

    set to true in order to keep displaying the grid when there is no data (default false). This can be useful when you want the user to be able to keep track of the current period (as dates are displayed in the columns headers). As a reminder, when no data are present and when this attribute is no set, the help content is displayed instead of the grid.

<button> (0+)

Regular Odoo action buttons, displayed in the view header

  • mandatory string attribute (the button label)

  • mandatory type attribute, either object or action

    注解

    workflow buttons are not supported

  • mandatory name attribute, either the name of the method to call, or the ID of the action to execute

  • optional context

The server callback is provided with all the record ids displayed in the view, either as the ids passed to the method (object button) or as the context’s active_ids (action buttons)

<field type="row"> (1+)

Row grouping fields, will be replaced by the search view’s groupby filter if any.

The order of row fields in the view provides their grouping depth: if the first field is school and the second is age the records will be grouped by school first and by age within each school.

<field type="col"> (1)

Column grouping field.

The col field can contain 0+ <range> elements which specify customisable column ranges. range elements have the following mandatory attributes

name

can be used to override the default range (the first one by default) through the grid_range context value

string

the range button’s label (user-visible)

span

symbolic name of the span of all columns to display at once in the view, may trigger pagination.

For date fields, valid spans are currently week and month.

step

symbolic name of the step between one column and the previous/next

For date fields, the only valid span is currently day.

<field type="measure"> (1)

Cell field, automatically accumulated (by read_group).

The measure field can take a widget attribute to customise its display.

Server interactions

Aside from optional buttons, the grid view currently calls two methods:

  • read_grid (provided on all models by the module) returns almost the entirety of the grid’s content as a dict:

    • the row titles is a list of dictionaries with the following keys:

      values (required)

      this maps to a dictionary with a key per row field, the values are always of the form [value, label].

      domain (required)

      the domain of any record at the source of this row, in case it’s necessary to copy a record during cell adjustment

    • the column titles is a list of dictionaries with at least one key:

      values (required)

      see row title values

      domain (required)

      see column domain value

      current (optional)

      boolean, marks/highlights a column

    • the grid data as a list (of rows) of list (of cells) of cell dicts each with the following keys:

      value

      the numeric value associated with the cell

      domain

      the domain matching the cell’s records (should be assumed opaque)

      size

      the number of records grouped in the cell

      readonly (optional)

      a boolean indicating that this specific cell should not be client-editable

      classes (optional)

      a list of classes (as strings) to add on the cell’s container (between the cell’s TD and the cell’s potentially-editable element).

      In case of conflicts between this list and the base classes (prefixed with o_grid_cell_), the classes in this list are ignored.

      Note that the grid data is dense, if querying the database yields no group matching a cell a cell will generate an “empty” cell with default values for required keys.

    • prev and next which can be either falsy (no pagination) or a context item to merge into the view’s own context to read_grid the previous or next page, it should be assumed to be opaque

  • read_grid_domain(field, range) (provided on al models by the module) returns the domain matching the current configured “span” of the grid. This is also done internally by read_grid, but can be useful or necessary to call independently to use with separate e.g. search_count or read_group.

  • adjust_grid, for which there currently isn’t a blanket implementation and whose semantics are likely to evolve with time and use cases

Server Hooks

read_grid calls a number of hooks allowing the customisation of its operations from within without having to override the entire method:

_grid_format_cell(group, cell_field)

converts the output of a read_group (group-by-group) into cells in the format described above (as part of “the grid data”)

_grid_make_empty_cell(row_domain, column_domain, view_domain)

generates an empty version of a cell (if there is no corresponding group)

_grid_column_info(name, range)

generates a ColumnMetadata object based on the column type, storing values either returned directly (as part of read_grid) or used query and reformat read_group into read_grid:

grouping

the actual grouping field/query for the columns

domain

domain to apply to read_group in case the column field is paginated, can be an empty list

prev and next

context segments which will be sent to read_grid for pages before and after the current one. If False, disables pagination in that direction

values

column values to display on the “current page”, each value is a dictionary with the following keys:

values

dictionary mapping field names to values for the entire column, usually just name -> a value

domain

domain matching this specific column

is_current

True if the current column should be specifically outlined in the grid, False otherwise

format

how to format the values of that column/type from read_group formatting to read_grid formatting (matching values in ColumnInfo)

ACL

  • if the view is not editable, individual cells won’t be editable

  • if the view is not creatable, the Add a Line button will not be displayed (it currently creates a new empty record)

Context Keys

grid_range

selects which range should be used by default if the view has multiple ranges

grid_anchor

if applicable, used as the default anchor of column ranges instead of whatever read_grid defines as its default.

For date fields, the reference date around which the initial span will be computed. The default date anchor is “today” (in the user’s timezone)

Kanban

The kanban view is a kanban board visualisation: it displays records as “cards”, halfway between a list view and a non-editable form view. Records may be grouped in columns for use in workflow visualisation or manipulation (e.g. tasks or work-progress management), or ungrouped (used simply to visualize records).

注解

The kanban view will load and display a maximum of ten columns. Any column after that will be closed (but can still be opened by the user).

The root element of the Kanban view is <kanban>, it can use the following attributes:

default_group_by

whether the kanban view should be grouped if no grouping is specified via the action or the current search. Should be the name of the field to group by when no grouping is otherwise specified

default_order

cards sorting order used if the user has not already sorted the records (via the list view)

class

adds HTML classes to the root HTML element of the Kanban view

examples

if set to a key in the KanbanExamplesRegistry, examples on column setups will be available in the grouped kanban view. Here is an example of how to define those setups.

group_create

whether the “Add a new column” bar is visible or not. Default: true.

group_delete

whether groups can be deleted via the context menu. Default: true.

group_edit

whether groups can be edited via the context menu. Default: true.

archivable

whether records belonging to a column can be archived / restored if an active field is defined on the model. Default: true.

quick_create

whether it should be possible to create records without switching to the form view. By default, quick_create is enabled when the Kanban view is grouped by many2one, selection, char or boolean fields, and disabled when not.

quick_create_view

form view reference, specifying the view used for records quick creation.

records_draggable

whether it should be possible to drag records when kanban is grouped. Default: true.

Set to true to always enable it, and to false to always disable it.

groups_draggable

whether it should be possible to resequence colunms when kanban is grouped. Default: true.

Set to true to always enable it, and to false to always disable it.

Possible children of the view element are:

field

declares fields to use in kanban logic. If the field is simply displayed in the kanban view, it does not need to be pre-declared.

Possible attributes are:

name (required)

the name of the field to fetch

allow_group_range_value (optional)

whether a date or datetime field allows a value computed from a group range (which consists of the first and last dates of the group). Enables the ‘quick create’ and ‘drag and drop’ features when the kanban view is grouped by that field. Default: false.

progressbar

declares a progressbar element to put on top of kanban columns.

Possible attributes are:

field (required)

the name of the field whose values are used to subgroup column’s records in the progressbar

colors (required)

JSON mapping the above field values to either “danger”, “warning”, “success” or “muted” colors

sum_field (optional)

the name of the field whose column’s records’ values will be summed and displayed next to the progressbar (if omitted, displays the total number of records)

templates

defines a list of QWeb Templates templates. Cards definition may be split into multiple templates for clarity, but kanban views must define at least one root template kanban-box, which will be rendered once for each record.

The kanban view uses mostly-standard javascript qweb and provides the following context variables:

widget

the current KanbanRecord(), can be used to fetch some meta-information. These methods are also available directly in the template context and don’t need to be accessed via widget

record

an object with all the requested fields as its attributes. Each field has two attributes value and raw_value, the former is formatted according to current user parameters, the latter is the direct value from a read() (except for date and datetime fields that are formatted according to user’s locale)

context

the current context, coming from the action, and the one2many or many2many field in the case of a Kanban view embedded in a Form view

user_context

self-explanatory

read_only_mode

self-explanatory

selection_mode

set to true when kanban view is opened in mobile environment from m2o/m2m field for selecting records.

注解

clicking on m2o/m2m field in mobile environment opens kanban view

buttons and fields

While most of the Kanban templates are standard QWeb Templates, the Kanban view processes field, button and a elements specially:

  • by default fields are replaced by their formatted value, unless the widget attribute is specified, in which case their rendering and behavior depends on the corresponding widget. Possible values are (among others):

    handle

    for sequence (or integer) fields by which records are sorted, allows to drag&drop records to reorder them.

  • buttons and links with a type attribute become perform Odoo-related operations rather than their standard HTML function. Possible types are:

    action, object

    standard behavior for Odoo buttons, most attributes relevant to standard Odoo buttons can be used.

    open

    opens the card’s record in the form view in read-only mode

    edit

    opens the card’s record in the form view in editable mode

    delete

    deletes the card’s record and removes the card

If you need to extend the Kanban view, see KanbanRecord().

List

The root element of list views is <tree>2. The list view’s root can have the following attributes:

editable

by default, selecting a list view’s row opens the corresponding form view. The editable attributes makes the list view itself editable in-place.

Valid values are top and bottom, making new records appear respectively at the top or bottom of the list.

The architecture for the inline form view is derived from the list view. Most attributes valid on a form view’s fields and buttons are thus accepted by list views although they may not have any meaning if the list view is non-editable

注解

if the edit attribute is set to false, the editable option will be ignored.

multi_edit

editable or not editable list can activate the multi-editing feature by defining the multi_edit=1

default_order

overrides the ordering of the view, replacing the model’s order (_order model attribute). The value is a comma-separated list of fields, postfixed by desc to sort in reverse order:

<tree default_order="sequence,name desc">
    ...
</tree>
decoration-{$name}

allow changing the style of a row’s text based on the corresponding record’s attributes.

{$name} can be bf (font-weight: bold), it (font-style: italic), or any bootstrap contextual color (danger, info, muted, primary, success or warning).

create, edit, delete, import, export_xlsx

allows disabling the corresponding action in the view by setting the corresponding attribute to false

limit

the default size of a page. It must be a positive integer

groups_limit

when the list view is grouped, the default number of groups of a page. It must be a position integer

expand

when the list view is grouped, automatically open the first level of groups if set to true (default: false)

Possible children elements of the list view are:

button

displays a button in a list cell

icon

icon to use to display the button

string

  • if there is no icon, the button’s text

  • if there is an icon, alt text for the icon

type

type of button, indicates how it clicking it affects Odoo:

object

call a method on the list’s model. The button’s name is the method, which is called with the current row’s record id and the current context.

action

load an execute an ir.actions, the button’s name is the database id of the action. The context is expanded with the list’s model (as active_model), the current row’s record (active_id) and all the records currently loaded in the list (active_ids, may be just a subset of the database records matching the current search)

name

see type

args

see type

attrs

dynamic attributes based on record values.

A mapping of attributes to domains, domains are evaluated in the context of the current row’s record, if True the corresponding attribute is set on the cell.

Possible attribute is invisible (hides the button).

states

shorthand for invisible attrs: a list of states, comma separated, requires that the model has a state field and that it is used in the view.

Makes the button invisible if the record is not in one of the listed states

危险

Using states in combination with attrs may lead to unexpected results as domains are combined with a logical AND.

context

merged into the view’s context when performing the button’s Odoo call

field

defines a column where the corresponding field should be displayed for each record. Can use the following attributes:

name

the name of the field to display in the current model. A given name can only be used once per view

string

the title of the field’s column (by default, uses the string of the model’s field)

invisible

fetches and stores the field, but doesn’t display the column in the table. Necessary for fields which shouldn’t be displayed but are used by e.g. @colors

groups

lists the groups which should be able to see the field

widget

alternate representations for a field’s display. Possible list view values are (among others):

progressbar

displays float fields as a progress bar.

handle

for sequence (or integer) fields by which records are sorted, instead of displaying the field’s value just displays a drag&drop icon to reorder records.

sum, avg

displays the corresponding aggregate at the bottom of the column. The aggregation is only computed on currently displayed records. The aggregation operation must match the corresponding field’s group_operator

attrs

dynamic attributes based on record values. Only effects the current field, so e.g. invisible will hide the field but leave the same field of other records visible, it will not hide the column itself

width (for editable)

when there is no data in the list, the width of a column can be forced by setting this attribute. The value can be an absolute width (e.g. ‘100px’), or a relative weight (e.g. ‘3’, meaning that this column will be 3 times larger than the others). Note that when there are records in the list, we let the browser automatically adapt the column’s widths according to their content, and this attribute is thus ignored.

decoration-{$name}

allow changing the style of a cell’s text based on the corresponding record’s attributes.

{$name} can be bf (font-weight: bold), it (font-style: italic), or any bootstrap contextual color (danger, info, muted, primary, success or warning).

nolabel

if set to “1”, the column header will remain empty. Also, the column won’t be sortable.

optional

makes the column optional. If set to “hide”, the column is hidden by default. If set to “show”, the column is visible by default. User visibility choices are stored in the browser local storage.

注解

if the list view is editable, any field attribute from the form view is also valid and will be used when setting up the inline form view.

注解

In case of list sub-views (One2many/Many2many display in a form view), The attribute column_invisible can be useful to hide a column depending on the parent object.

<field name="product_is_late" attrs="{'column_invisible': [('parent.has_late_products', '=', False)]}"/>

注解

When a list view is grouped, numeric fields are aggregated and displayed for each group. Also, if there are too many records in a group, a pager will appear on the right of the group row. For this reason, it is not a good practice to have a numeric field in the last column, when the list view is in a situation where it can be grouped (it is however fine for x2manys field in a form view: they cannot be grouped).

groupby

defines custom headers (with buttons) for the current view when grouping records on many2one fields. It is also possible to add field, inside the groupby which can be used for modifiers. These fields thus belong on the many2one comodel. These extra fields will be fetched in batch.

name

the name of a many2one field (on the current model). Custom header will be displayed when grouping the view on this field name.

<groupby name="partner_id">
  <field name="name"/> <!-- name of partner_id -->
  <button type="edit" name="edit" string="Edit"/>
  <button type="object" name="my_method" string="Button1"
    attrs="{'invisible': [('name', '=', 'Georges')]}"/>
</groupby>

A special button (type="edit") can be defined to open the many2one form view.

control

defines custom controls for the current view.

This makes sense if the parent tree view is inside a One2many field.

Does not support any attribute, but can have children:

create

adds a button to create a new element on the current list.

注解

If any create is defined, it will overwrite the default “add a line” button.

The following attributes are supported:

string (required)

The text displayed on the button.

context

This context will be merged into the existing context when retrieving the default value of the new record.

For example it can be used to override default values.

The following example will override the default “add a line” button by replacing it with 3 new buttons: “Add a product”, “Add a section” and “Add a note”.

“Add a product” will set the field ‘display_type’ to its default value.

The two other buttons will set the field ‘display_type’ to be respectively ‘line_section’ and ‘line_note’.

<control>
  <create
    string="Add a product"
  />
  <create
    string="Add a section"
    context="{'default_display_type': 'line_section'}"
  />
  <create
    string="Add a note"
    context="{'default_display_type': 'line_note'}"
  />
</control>
2

for historical reasons, it has its origin in tree-type views later repurposed to a more table/list-type display

Map

Enterprise feature

This view is able to display records on a map and the routes between them. The records are represented by pins. It also allows the visualization of fields from the model in a popup tied to the record’s pin.

注解

The model on which the view is applied should contain a res.partner many2one since the view relies on the res.partner’s address and coordinates fields to localize the records.

API

The view uses location data platforms’ API to fetch the tiles (the map’s background), do the geoforwarding (converting addresses to a set of coordinates) and fetch the routes. The view implements two API, OpenStreetMap and MapBox. OpenStreetMap is used by default and is able to fetch tiles and do geoforwarding. This API does not require a token. As soon as a valid MapBox token is provided in the general settings the view switches to the MapBox API. This API is faster and allows the computation of routes. A token can be obtained by signing up to MapBox.

Structural components

The view’s root element is <map>. It can have the following attributes:

res_partner

Contains the res.partner many2one. If not provided the view resorts to create an empty map.

default_order

If a field is provided the view overrides the model’s default order. The field must be part of the model on which the view is applied, not from res.partner.

routing

if 1 display the routes between the records. The view needs a valid MapBox token and at least two located records (i.e the records have a res.partner many2one and the partner has an address or valid coordinates).

hide_name

if 1 hide the name from the pin’s popup (default: 0).

hide_address

if 1 hide the address from the pin’s popup (default: 0).

hide_title

if 1 hide the title from the pin list (default: 0).

panel_title

String to display as title of the pin list. If not provided, the title is the action’s name or “Items” if the view is not in an action.

limit

Maximum number of records to fetch (default: 80). It must be a positive integer.

The <map> element can contain multiple <field> elements. Each <field> element is interpreted as a line in the pin’s popup. The field’s attributes are the following:

name

The field to display.

string

String to display before the field’s content. It can be used as a description.

For example here is a map:
<map res_partner="partner_id" default_order="date_begin" routing="1" hide_name="1">
    <field name="partner_id" string="Customer Name"/>
</map>

Pivot

The pivot view is used to visualize aggregations as a pivot table. Its root element is <pivot> which can take the following attributes:

disable_linking (optional)

Set to 1 to remove table cell’s links to list view.

display_quantity (optional)

Set to 1 to display the Quantity column by default.

default_order (optional)

The name of the measure and the order (asc or desc) to use as default order in the view.

<pivot default_order="foo asc">
   <field name="foo" type="measure"/>
</pivot>

The only allowed element within a pivot view is field which can have the following attributes:

name (mandatory)

the name of a field to use in the view. If used for grouping (rather than aggregating)

string (optional)

the name that will be used to display the field in the pivot view, overrides the default python String attribute of the field.

type (optional)

indicates whether the field should be used as a grouping criteria or as an aggregated value within a group. Possible values are:

row (default)

groups by the specified field, each group gets its own row.

col

creates column-wise groups

measure

field to aggregate within a group

interval

on date and datetime fields, groups by the specified interval (day, week, month, quarter or year) instead of grouping on the specific datetime (fixed second resolution) or date (fixed day resolution).

invisible (optional)

if true, the field will not appear either in the active measures nor in the selectable measures (useful for fields that do not make sense aggregated, such as fields in different units, e.g. € and $).

The measures are automatically generated from the model fields; only the aggregatable fields are used. Those measures are also alphabetically sorted on the string of the field.

警告

like the graph view, the pivot aggregates data on database content which means that non-stored function fields can not be used in pivot views

In Pivot view a field can have a widget attribute to dictate its format. The widget should be a field formatter, of which the most interesting are date, datetime, float_time, and monetary.

For instance a timesheet pivot view could be defined as:

<pivot string="Timesheet">
    <field name="employee_id" type="row"/>
    <field name="date" interval="month" type="col"/>
    <field name="unit_amount" type="measure" widget="float_time"/>
</pivot>

QWeb

QWeb views are standard QWeb Templates templates inside a view’s arch. They don’t have a specific root element. Because QWeb views don’t have a specific root element, their type must be specified explicitly (it can not be inferred from the root element of the arch field).

QWeb views have two use cases:

  • they can be used as frontend templates, in which case template should be used as a shortcut.

  • they can be used as actual qweb views (opened inside an action), in which case they should be defined as regular view with an explicit type (it can not be inferred) and a model.

The main additions of qweb-as-view to the basic qweb-as-template are:

  • qweb-as-view has a special case for a <nav> element bearing the CSS class o_qweb_cp_buttons: its contents should be buttons and will be extracted and moved to the control panel’s button area, the <nav> itself will be removed, this is a work-around to control panel views not existing yet

  • qweb-as-view rendering adds several items to the standard qweb rendering context:

    model

    the model to which the qweb view is bound

    domain

    the domain provided by the search view

    context

    the context provided by the search view

    records

    a lazy proxy to model.search(domain), this can be used if you just want to iterate the records and not perform more complex operations (e.g. grouping)

  • qweb-as-view also provides additional rendering hooks:

    • _qweb_prepare_context(view_id, domain) prepares the rendering context specific to qweb-as-view

    • qweb_render_view(view_id, domain) is the method called by the client and will call the context-preparation methods and ultimately env['ir.qweb'].render().

Search defaults

Search fields and filters can be configured through the action’s context using search_default_name keys. For fields, the value should be the value to set in the field, for filters it’s a boolean value or a number. For instance, assuming foo is a field and bar is a filter an action context of:

{
  'search_default_foo': 'acro',
  'search_default_bar': 1
}

will automatically enable the bar filter and search the foo field for acro.

A numeric value (between 1 and 99) can be used to describe the order of default groupbys. For instance if foo and bar refer to two groupbys

{
  'search_default_foo': 2,
  'search_default_bar': 1
}

has the effect to activate first bar then foo.