Представления

Common Structure

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

name (обязательный параметр)
only useful as a mnemonic/description of the view when looking for one in a list of some sort
model
the model linked to the view, if applicable (it doesn’t for QWeb views)
priority

client programs can request views by id, or by (model, type). For the latter, all the views for the right type and model will be searched, and the one with the lowest priority number will be returned (it is the «default view»).

priority also defines the order of application during view inheritance

arch
the description of the view’s layout
groups_id
Many2many field to the groups allowed to view/use the current view
inherit_id
the current view’s parent view, see Наследование., unset by default
mode
inheritance mode, see Наследование.. If inherit_id is unset the mode can only be primary. If inherit_id is set, extension by default but can be explicitly set to primary
application
website feature defining togglable views. By default, views are always applied
banner_route

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

Если этот атрибут установлен то данный url контроллера будет запрошен и отображен поверх представления. Ответ json от контроллера должен содержать ключ «html».

Если html содержит тег <link> таблицы стилей, он будет удален и добавлен в <head>.

Для взаимодействия с бекэндом вы можете использовать теги <a type=»action»> . Пожалуйста обратите внимание в документации на метод _onActionClicked класса AbstractController (addons/web/static/src/js/views/abstract_controller.js) для того чтобы узнать об этом поподробнее.

Только те представления, которые расширяют AbstractView и AbstractController могут использовать атрибуты, например такие как Forms, Kanban, Lists, …

Пример:

<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> """
        }

Наследование.

Соответствие представления

  • 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

Разрешение представления

Разрешение генерирует финальный arch для запрошенного/совпадающего primary представления:

  1. если представление имеет предка и родительский элемент полностью опознан, тогда применяются спецификации наследования текущего представления
  2. Если у представления нет родителя, его arch используется как есть
  3. дочерние элементы текущего представления с режимом extension ищутся, и их спецификации наследования применяются сначала в глубину (применяется дочернее представление, затем его дочерние элементы, затем его родные элементы)

Результатом применения представлений дочерних элементов является финальный вариант arch

Определение наследования

Определение наследования состоит из элемента локатора, для поиска наследуемого элемента в родительском представлении и дочернего элемента, который будет использоваться для изменения унаследованного элемента.

Существует три типа локаторов для поиска целевого элемента:

  • директива xpath с атрибутом expr. expr - выражение XPath expression2 , примененное к текущему arch, первый узел, который он находит и является искомым
  • директива field с атрибутом name, находит первое вхождение field с тем же name. Все остальные атрибуты игнорируются при совпадении
  • любой другой элемент: первый элемент с тем же именем и идентичными атрибутами (игнорируются атрибуты position и version) и будет искомым

Определение наследования может иметь необязательный атрибут position, определяющий, каким образом должен быть найден нужный узел для дальнейшего изменения:

inside (по умолчанию)
содержимое определенного наследования добавляется к найденному узлу
replace
содержимое определенного наследования заменяет найденный узел. Любой текстовый узел, содержащий только $ 0 внутри содержимого спецификации, будет заменен полной копией найденного узла, эффективно обернув найденный узел.
after
содержимое определенного наследования добавляется к родительскому элементу найденного узла сразу после этого узла
before
Содержимое определения наследования добавляется к родительскому элементу найденного узла перед ним
attributes

в определении наследования должны быть элементы attribute с атрибутом name и содержимым, наличие которого не является обязательным:

  • если у элемента attribute есть содержимое, в найденном узле создается новый атрибут, после его name, с текстом элемента attribute как значением
  • если у элемента attribute нет тела, атрибут, указанный после его name, удаляется из найденного узла. Если такой атрибут отсутствует, возникает ошибка

Additionally, the position move can be used as a direct child of a 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>

Определения представления применяются последовательно.

Lists

Корневым элементом представления List является <tree>3. Корень представления может иметь следующие атрибуты:

editable

по умолчанию выбор строки представления списка открывает соответствующее представление Form. Атрибуты editable дают возможность редактировать данные прямо в представлении List.

Допустимыми значениями являются top и bottom, в результате чего новые записи появляются соответственно в верхней или нижней части списка.

Внутреннее устройство представление Form является производным представления List. Большинство атрибутов допустимы представлением Form, и точно таким же образом, кнопки принимаются представлениями List, хотя они могут не иметь никакого значения, если представление List недоступно для редактирования

default_order

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

<tree default_order="sequence,name desc">
colors

Не рекомендуется, начиная с версии 9.0: replaced by decoration-{$name}

fonts

Не рекомендуется, начиная с версии 9.0: replaced by decoration-{$name}

decoration-{$name}

позволяют изменять стиль текста строки на основе атрибутов связанной записи.

Значения - это выражения Python. Для каждой записи выражение вычисляется по атрибутам записи как значениям контекста и если вычисление возвращает true, то соответствующий стиль применяется к строке. Другими значениями контекста являются uid (id текущего пользователя) и current_date (текущая дата в виде строки формы yyyy-MM-dd).

{$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
непозволяет изменять соответствующее действие в представлении, устанавливая нужный атрибут на false
limit
the default size of a page. It should be a positive integer
on_write

only makes sense on an editable list. Should be the name of a method on the list’s model. The method will be called with the id of a record after having created or edited that record (in database).

The method should return a list of ids of other records to load or update.

string

alternative translatable label for the view

Не рекомендуется, начиная с версии 8.0: not displayed anymore

Допустимыми дочерними элементами представления List являются:

button

отображает кнопку в ячейке

icon
иконка для отображения кнопки
string
  • если icon отсутствует, текст кнопки
  • если есть icon, alt текст для иконки
type

тип кнопки, указывает, как это нажатие влияет на Odoo:

object
вызывает метод в модели представления List. name кнопки - это метод, который вызывается с идентификатором записи текущей строки и текущим контекстом.
action
загружает и выполняет ir.actions, name кнопки - это id записи действия в базе данных. Контекст расширяется с помощью модели списка (как active_model), записи текущей строки (active_id) и всех записей, загружаемых в данный момент в списке (active_ids, может быть просто подмножеством записей базы данных, соответствующие текущему поиску)
name
см. type
args
см. type
attrs

динамические атрибуты, основанные на значениях записи.

Отображение атрибутов в доменах, домены вычисляются в контексте записи текущей строки, если True, соответствующий атрибут задан ячейке.

Допустимые атрибуты invisible (делает кнопку недоступной).

states

сокращение для invisible attrs: список состояний, разделенных запятой, требует, чтобы модель имела поле state и использовалась в представлении.

Делает кнопку invisible, если запись не в одном из перечисленных состояний

context
объединяется с контекстом представления при выполнении вызова функции Odoo при клике по кнопке
confirm
confirmation message to display (and for the user to accept) before performing the button’s Odoo call
field

определяет столбец, в котором соответствующее поле должно отображаться для каждой записи. Может использовать следующие атрибуты:

name
имя поля в текущей модели для отображения . Данное имя может использоваться в представлении только один раз
string
заголовок столбца поля (по умолчанию используется параметр `` string`` поля модели)
invisible
загружает и сохраняет поле, но не отображает столбец в таблице. Необходимо для полей, которые не должны отображаться, но используются, например, @colors
groups
списки групп пользователей, которые могут видеть поле
widget

alternate representations for a field’s display. Possible list view values are:

progressbar
отображает поля float как прогрессбар.
many2onebutton
replaces the m2o field’s value by a checkmark if the field is filled, and a cross if it is not
handle
for sequence fields, instead of displaying the field’s value just displays a drag&drop icon
sum, avg
отображает соответствующее объединение в нижней части столбца. Объединение вычисляется только по отображаемым в настоящее время записям. Операция объединения должна соответствовать ``group_operator` соответствующего поля
attrs
динамические атрибуты, основанные на значениях записи. Воздействует только на текущее поле, так, например, invisible скроет поле, но оставит его видимым для других записей, и не будет прятать сам столбец
control

определяет пользовательские элементы управления для текущего представления.

Это имеет смысл, если родительское представление tree находится внутри поля One2many.

Не поддерживает никаких атрибутов, но может иметь дочерние элементы:

create

добавляет кнопку для создания нового элемента в текущем списке.

Допустимы следующие атрибуты:

string (обязательный параметр)
Текст отображаемый на кнопке.
context

Этот контекст будет объединен с существующим контекстом при получении значения по умолчанию для новой записи.

Для примера он может быть использован для перегрузки значений по умолчанию.

В следующем примере будет переопределена кнопка по умолчанию «Добавить строку», заменив ее тремя новыми кнопками: «Добавить продукт», «Добавить раздел» и «Добавить заметку».

«Добавить продукт» установит в поле display_type значение по умолчанию.

Две другие кнопки установят поле display_type соответственно в line_section и 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>

Forms

Представления Form используются для отображения данных одной записи. Их корневой элемент - <form>. Они состоит из обычного HTML с дополнительными структурными и семантическими компонентами.

Структурные компоненты

Структурные компоненты обеспечивают структуру или «визуальные» функции с небольшим количеством логики. Они используются как элементы или наборы элементов в представлениях Form.

notebook

определяет секцию с вкладками. Каждая вкладка определяется через дочерний элемент page. page элементы могут иметь следующие атрибуты:

string (обязательный параметр)
the title of the tab
accesskey
an HTML accesskey
attrs
standard dynamic attributes based on record values
group

используется для определения расположения столбцов в представлениях Form. По умолчанию группы определяют 2 столбца, а большинство прямых потомков групп занимают один столбец. Прямые прямые потомки field по умолчанию отображают значение label, а label и feild имеют colspan по 1 каждому.

Количество столбцов в group можно настроить с помощью атрибута col, количество столбцов, взятых элементом, можно настроить с помощью colspan.

Дочерние элементы располагаются горизонтально (пытаются заполнить следующий столбец перед сменой строки).

Группы могут иметь атрибут строка, который отображается как название группы

newline
полезен только внутри элементов group, рано заканчивает текущую строку и сразу переключается на новую строку (без предварительного заполнения любого оставшегося столбца)
separator
небольшой горизонтальный интервал с атрибутом string ведет себя как заголовок раздела
sheet
может использоваться в качестве прямого потомка для form придания представлению Form более компактный вид, превращая его как бы в бумажный лист
header
в сочетании с sheet, обеспечивает область во всю ширину над основным блоком, как правило, используется для отображения кнопок рабочего процесса и виджетов состояния

Семантические компоненты

Семантические компоненты выступают в качестве связующих звеньев и позволяют взаимодействовать с системой Odoo. Допустимыми семантическими компонентами являются:

button

инициирует вызов функции внутри системы Odoo, аналогично кнопки представления List. Кроме того, можно указать следующий атрибут:

special
для представлений Form открывается диалоговом режиме: save сохранить запись и закрыть , cancel закрывает без сохранения.
field

renders (and allow edition of, possibly) a single field of the current record. Possible attributes are:

name (обязательный параметр)
имя отображаемого поля
widget
поля разный внешний вид по умолчанию в зависимости от их типа (например Char, Many2one). Атрибуты widget позволяют использовать другой метод визуализации и контекст.
options
Параметр конфигурации объекта JSON для виджета поля (включая виджеты по умолчанию)
class

Класс HTML для установки на сгенерированный элемент, классы field:

oe_inline
предотвратить обычный разрыв строки после полей
oe_left, oe_right
floats это свойство CSS будет применено к полю с соответствующим направлением
oe_read_only, oe_edit_only
отображает поле только в соответствующем режиме формы
oe_no_button
avoids displaying the navigation button in a Many2one
oe_avatar
для полей изображений, отображает изображения как аватары (имеет форму квадрата, максимальный размер 90x90 и некоторые декораторы)
groups
отображает поле только для определенных пользователей
on_change

вызывает указанный метод, когда значение этого поля редактируется, может генерировать обновления других полей или отображать предупреждения для пользователя

Не рекомендуется, начиная с версии 8.0: Используйте декоратор odoo.api.onchange() внутри самой модели

attrs
динамические мета-параметры, основанные на значениях записи
domain
только для реляционных полей, фильтры, применяемые при отображении существующих записей
context
только для реляционных полей, контекст для запроса возможных значений
readonly
Отображать поле как в режиме только для чтения, так и в режиме редактирования, но никогда не позволяет редактировать его самого
required
генерирует ошибку и предотвращает сохранение записи, если поле не имеет значения
nolabel
не отображать метку поля автоматически, имеет смысл только в том случае, если поле является прямым потомком элемента group
placeholder
показывает вспомогательное сообщение пустых полях. Может заменять метки полей в сложных формах. Не должны быть похожи на уже введенные данные , так как пользователи могут путать текст заполнитель с заполненными полями
mode
для One2many, режим отображения (тип представления) для использования связанных записей поля. Может иметь одно из следующих значений tree, form, kanban или graph. по умолчания tree (отображается в виде списка)
help
Подсказка, отображаемая для пользователей при наведении курсора на поле или его метку
filename
для полей с типом binary, имя поля, предоставляющего имя файла
password
указывает, что поле Char хранит пароль и что его данные не должны отображаться

Graphs

Представление Graph используется для визуализации сводных данных по нескольким записям или группам записей. Его корневым элементом является ``<graph> ``, который может принимать следующие атрибуты:

type
каждое из этих значений bar (по умолчанию), pie и line, это тип используемого графика
stacked
используется только для графика с типом bar. Если таковой тип присутствует установлен в True, то колонки будут объеденены в группы

Единственным допустимым элементом в представлении Graph является field, которое может иметь следующие атрибуты:

name (обязательный атрибут)
имя поля для использования представлении. Если используется для группировки (а не объединения)
title (необязательный параметр)
строка отображаемая вверху представления.
type

указывает, должно ли поле использоваться как критерий группировки или как агрегированное значение внутри группы. Возможные значения:

row (по умолчанию)
группирует по указанному полю. Все типы графиков поддерживают по крайней мере один уровень группировки, некоторые могут поддерживать больше.
col
авторизован в представлениях Graph, но используется только в pivot таблицах
measure
поле для агрегирования внутри группы
interval
применяется к date и datetime полям, группирует по указанным интервалам (day, week, month, quarter или year)вместо группировки по указанному времени (фиксированные значения секунд) или дате (фиксированные значения дней).

измерения автоматически генерируются из полей модели; используются только агрегируемые поля. Эти измерения также сортируются в алфавитном порядке по строке поля.

Pivots

Представление Pivot используется для визуализации объединенных данных как pivot таблицы. Его корневым элементом является <pivot>, который может принимать следующие атрибуты:

disable_linking
Установите True, чтобы удалить ссылки ячеек таблицы на представление List.
display_quantity
Установите true, чтобы отображать колонку количества по умолчанию.
default_order

Имя измерения и порядок сортировки (asc или desc) для использования по умолчанию в представлении.

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

Единственным допустимым элементом в представлении Pivot является field, которое может иметь следующие атрибуты:

name (обязательный атрибут)
имя поля для использования представлении. Если используется для группировки (а не объединения)
string
имя, которое будет использоваться для отображения поля в представлении Pivot, переопределяет атрибут поля string в Python.
type

указывает, должно ли поле использоваться как критерий группировки или как агрегированное значение внутри группы. Возможные значения:

row (по умолчанию)
группировка по указанному полю, каждая группа получает свою строку.
col
создает группы колонок
measure
поле для агрегирования внутри группы
interval
применяется к date и datetime полям, группирует по указанным интервалам (day, week, month, quarter или year)вместо группировки по указанному времени (фиксированные значения секунд) или дате (фиксированные значения дней).
invisible
если true, поле не появится в активных измерениях ни в выбираемых (полезно для полей, которые не имеет смысла агрегировать, такие как поля в разных единицах, например, € и $).

измерения автоматически генерируются из полей модели; используются только агрегируемые поля. Эти измерения также сортируются в алфавитном порядке по строке поля.

В представлении Pivot field может иметь атрибут widget который диктует его формат. widget - это средством форматирования поля, наиболее интересными из которых являются date, datetime, float_time, и monetary.

Например, Pivot представление расписания может быть определено как:

<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>

Kanban

Представление Kanban являет собой визуализацию канбан доску: она отображает записи как « карты», и призваны заполнить промежуточную нишу между представлением List и нередактируемым представлением Form. Записи могут быть сгруппированы в столбцы для использования для визуализации рабочего процесса или в его манипуляции (например для отображения задач или управления прогрессом работ) или не группироваться (используются просто для визуализации записей).

Корневым элементом представления Kanban является <kanban>, он может использовать следующие атрибуты:

default_group_by
указывает на то, следует ли группировать представление Kanban, если группировка не указана с помощью действия или текущего поиска. Должно быть именем поля, по которому нужно группировать, если никакая другая группировка не указана
default_order
порядок сортировки карточек, если пользователь еще не отсортировал записи (через представление List)
class
добавляет HTML-классы к корневому элементу HTML представления Kanban
group_create
определяет видим ли элемент «Добавить новую колонку». По умолчанию: true.
group_delete
определяет могут ли группы быть удалены через контекстное меню. По умолчанию: true.
group_edit
определяет могут ли группы быть отредактированы через контекстное меню. По умолчанию: true.
archivable
определяет могут ли записи колонки быть заархивированы/восстановлены если поле active определено в модели. По умолчанию: true.
quick_create

определяет следует ли создавать записи без переключения на представление Form. По умолчанию, quick_create включено, когда представление Kanban сгруппировано по many2one, selection, char или boolean полям и отключено, если нет.

Установите true чтобы всегда разрешать, и false всегда отключать.

Допустимые дочерние элементы представления:

field

объявляет поля для агрегирования или для использования в kanban *логике *. Если поле просто отображается в представлении Kanban, его не нужно предварительно объявлять.

Допустимые атрибуты:

name (обязательный атрибут)
имя требуемого поля
progressbar

объявляет элемент прогрессбара, который будет находится сверху канбан колонки.

Допустимые атрибуты:

field (обязательный параметр)
имя поля, значения которого используются для учета записей столбца в прогресбаре
colors (обязательный параметр)
JSON mapping the above field values to either «danger», «warning» or «success» colors
sum_field (необязательный параметр)
имя поля, значения записей в столбце которого будут суммироваться и отображаться рядом с прогресбаром (если опущено, отображает общее количество записей)
templates

определяет список QWeb шаблонов. Определение карточек может быть разбито на несколько шаблонов для большей наглядности, но представления Kanban должны определять хотя бы один корневой шаблон kanban-box, который будет отображаться один раз для каждой записи.

Представление Kanban использует в основном javascript qweb и предоставляет следующие контекстные переменные:

widget
текущий класс KanbanRecord(), может быть испльзован для доступа к мета-информации. Эти методы так же доступны прямо из контекста шаблона и не требуют доступа через widget
record
объект со всеми запрошенными полями в качестве атрибутов. Каждое поле имеет два атрибута value и raw_value, первое форматируется в соответствии с текущими пользовательскими параметрами, второе является прямым значением из read() (кроме полей date и datetime которые форматируются на базе локали пользователя)
read_only_mode

название говорит само за себя

Кнопки и поля

Пока большинство Kanban шаблонов это стандартный QWeb, представление Kanban специальные элементы field, button и a:

  • by default fields are replaced by their formatted value, unless they match specific kanban view widgets

  • кнопки и ссылки с атрибутом type стали выполнять операции, связанные с Odoo, а не их стандартную функцию HTML. Возможные типы:

    action, object
    стандартное поведение для Odoo buttons, можно использовать большинство атрибутов, относящихся к стандартным кнопкам Odoo.
    open
    открывает запись карточки в представлении Form в режиме только для чтения
    edit
    открывает запись карты в представлении Form в редактируемом режиме
    delete
    удаляет запись карты и удаляет карту

Если вы хотите расширить представление Kanban смотрите :js:class::[UNKNOWN NODE title_reference].

Calendar

Представление Calendar записи как события в однодневном, недельном или месячном календарях. Его корневым элементом является <calendar>. Допустимыми атрибутами в представлении Calendar являются:

date_start (обязательный атрибут)
имя поля записи, содержащее дату начала события
date_stop
имя поля записи, содержащее дату окончания события, если указана date_stop, записи становятся подвижными (с помощью перетаскивания) непосредственно в представлении Calendar
date_delay
альтернатива date_stop, указывает продолжительность события, а не его дату окончания (едица: день)
color
имя поля записи, используемое для цветового разделения. Записи в одного сегмента в представлении Calendar подсвечиваются тем же цветом, значения цветов распределяются псевдо-случайным образом. На боковой панели отображается легенда
readonly_form_view_id
view to open in readonly mode
form_view_id
ссылка на id представления, которое будет открываться когда пользователь захочет создать или отредактировать запись. Обратите внимание, что если этот атрибут не установлен, представление Calendar будет пытать обратиться к идентификатору представления Form в текущем закрепленным за этим действием, если таковое существует.
event_open_popup
Если для параметра event_open_popup задано значение true, представление Calendar будет открывать события (или записи) в FormViewDialog. В противном случае он откроет события в новом представлении From (с помощью do_action)
quick_add
включает быстрое создание событий при клике: запрашивает у пользователя name и пытается создать новое событие именно с тем временем, куда был произведен клик. Возвращается к вышеописанному диалоговому окну, если быстрое создание не удалось выполнить
all_day
имя поля типа Boolean, указывающее, отмечено ли соответствующее событие как занимающее целый день (продолжительность не имеет значения)
mode
Режим отображения по умолчанию при загрузке представления Calendar. Допустимые атрибуты: day, week, month
<field>

объявляет поля для объединения или для использования в логике kanban . Если указано то поле просто отображается в карточке Calendar.

Поля могут иметь следующие дополнительные атрибуты:

invisible
use «True» to hide the value in the cards
avatar_field
only for x2many field, to display the avatar instead the display_name in the cards
write_model and write_field
you can add a filter and save the result in the defined model, the filter is added in the sidebar
templates

определяет QWeb шаблон calendar-box. Определение карточек может быть разбито на несколько шаблонов для большей наглядности, которые будут рендерится для каждой записи.

Представление Kanban использует в основном javascript qweb и предоставляет следующие контекстные переменные:

widget
текущий класс KanbanRecord(), может быть использован для доступа к некоторой метаинформации. Эти методы также доступны прямо в контексте шаблона и нет необходимость иметь доступ к widget getColor для преобразования числа определяющего цвет getAvatars для смены изображения аватра displayFields список скрытых полей
record
объект атрибутами которого являются запрошенные поля. Каждое поле имеет два атрибута value и raw_value
event
объект события
format
метод для преобразования значений в читаемую строку с пользовательскими параметрами
fields
определение параметров всех полей модели
user_context
название говорит само за себя
read_only_mode
название говорит само за себя

Gantt

Представления Gantt предназначены для формирования диаграмм Ганта (они, как правило, применяются для планирования).

Корневым элементом представлений Gantt является ``<gantt /> ``, у него нет потомков, но он может принимать следующие атрибуты:

date_start (обязательный атрибут)
Имя поля, указывающего на дату начала события для каждой записи.
date_stop

name of the field providing the end duration of the event for each record. Can be replaced by date_delay. One (and only one) of date_stop and date_delay must be provided.

If the field is False for a record, it’s assumed to be a «point event» and the end date will be set to the start date

date_delay
name of the field providing the duration of the event
duration_unit
one of minute, hour (default), day, week, month, year
default_group_by
имя поля для группировки задач
type

gantt classic gantt view (default)

consolidate values of the first children are consolidated in the gantt’s task

planning children are displayed in the gantt’s task

consolidation
имя поля для отображения значения консолидации в ячейке записи
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 describe if the task has to be excluded from the consolidation if set to true it displays a striped zone in the consolidation line

create, edit
непозволяет изменять соответствующее действие в представлении, устанавливая нужный атрибут на false
string
string to display next to the consolidation value, if not specified, the label of the consolidation field will be used
fold_last_level
If a value is set, the last grouping level is folded
round_dnd_dates
enables rounding the task’s start and end dates to the nearest scale marks
drag_resize
resizing of the tasks, default is true
progress
имя поля, предоставляющего процент завершения события записи, от 0 до 100

Diagram

Представление Diagram может использоваться для отображения ориентированных графов записей. Корневой элемент <diagram> и не имеет атрибутов.

Допустимые дочерние элементы представления Ddiagram:

node (обязательный параметр, 1)

Определяет узлы графа. Его атрибуты:

object
узел модели Odoo
shape
Условное сопоставление фигуры с цветами и шрифтами в the list view. Единственной допустимой фигурой является rectangle (фигура по умолчанию - элипс)
bgcolor
тоже что и shape, но условно сопостявляет фоновый цвет для узлов. По умолчанию цвет фона - белый, единственной допустимой альтернативой является grey.
arrow (обязательный параметр, 1)

Определяет направленные ребра графа. Его атрибуты:

object (обязательный параметр)
Модель Odoo в качестве ребра
source (обязательный параметр)
Many2one поле модели ребра которая указывает на запись, которая является начальной точкой ребра
destination (обязательный параметр)
Many2one поле модели ребра которая указывает на запись, которая является конечной точкой ребра
label
Список атрибутов Python (в виде цитируемых строк). Соответствующие значения атрибутов будут объединены и отображены как метка ребра
label
Примечание для диаграммы, атрибут string определяет содержание примечания. Каждая label выводится как параграф в заголовке диаграммы.

Dashboard

Как представления Pivot и Graph, представление Dashboard используется для отображения агрегированных данных. Тем не менее, в Dashboard могут быть вложенные представления, что позволяет более полно и интересно взглянуть на выбранный набор данных.

Представление Dashboard может отображать вложенные представления, множества для полей (через домен), или даже формулы (выражения, которые включают в себя один или несколько множеств). Вот простой пример представления Dashboard:

<dashboard>
    <view type="graph" ref="sale_report.view_order_product_graph"/>
    <group string="Sale">
        <aggregate name="price_total" field="price_total" widget="monetary"/>
        <aggregate name="order_id" field="order_id" string="Orders"/>
        <formula name="price_average" string="Price Average"
            value="record.price_total / record.order_id" widget="percentage"/>
    </group>
    <view type="pivot" ref="sale_report.view_order_product_pivot"/>
</dashboard>

Корневым элементом представления Dashboard является <dashboard>. Он не принимает атрибутов.

Существует 5 допустимых тегов и представлении Dashboard:

view

определяет вложенные представления.

Допустимые атрибуты:

  • type (обязательный атрибут)
    Тип вложенного представления. Например graph или pivot.
  • ref (необязательный атрибут)
    xml id представления. Если не указан, то будет использовано представление по умолчанию для модели.
  • name (необязательный атрибут)
    Строка, которая идентифицирует этот элемент. В основном это полезно при использования в качестве цели для xpath.
group

определяет расположение столбцов. На самом деле это очень похоже на элемент группы в представлении Form.

Допустимые атрибуты:

  • string (необязательный атрибут)
    Описание которое будет отображаться в названии группы.
  • colspan (необязательный атрибут)
    Количество колонок в группе, по умолчанию 6.
  • col (необязательный атрибут)
    Количество столбцов, охватываемых этой группой (имеет смысл только внутри другой группы). По умолчанию 6.
aggregate

объявляет множество. Это значение множества для данного поля в текущем домене.

Обратите внимание что тег aggregates используются внутри тега ``group `` (иначе стиль не будет применен должным образом).

Допустимые атрибуты:

  • field (обязательный параметр)

    Имя поля, используемого для вычисления множества. Возможные типы поля:

    • integer (оператором по умолчанию является сумма)
    • float (оператором по умолчанию является сумма)
    • many2one (оператором по умолчанию является количество )
  • name (обязательный параметр)
    Строка идентифицирующая данное множество (полезно для использования в формулах)
  • string (необязательный атрибут)
    Краткое описание, которое будет отображаться над значением. Если не указанно, то будет показано содержимое поля string.
  • domain (необязательный параметр)
    Дополнительное ограничение на набор записей, которые мы хотим использовать во множестве. Этот домен будет объединен с текущим доменом.
  • domain_label (необязательный параметр)
    Когда пользователь нажимает на множество с доменом, он будет добавлен в представление Search как отдельный запрос. Строка, отображаемая для этого запроса, может быть настроена с помощью этого атрибута.
  • group_operator (необязательный параметр)

    Действительный идентификатор агрегатной функции PostgreSQL, который будет использоваться при объединении значений(см. https://www.postgresql.org/docs/9.5/static/functions-aggregate.html). Если не указано иное, по умолчанию используется group_operator из определения поля. Обратите внимание, что множество значений полей не будет достигнуто, если значение ``group_operator `` равно «».

    <aggregate name="price_total_max" field="price_total" group_operator="max"/>
  • col (необязательный атрибут)
    Количество столбцов, охватываемых этим тегом (имеет смысл только внутри группы). По умолчанию 1.
  • widget (необязательный параметр)
    Виджет для форматирования значения (как, атрибут widget для полей). Например, monetary.
  • help (необязательный параметр)
    Справочное сообщение для отображения во всплывающей подсказке (эквивалент параметра help для поля в Python)
  • measure (необязательный атрибут)

    Этот атрибут представляет собой имя поля, описывающего меру, которая должна использоваться в представлениях Graph и Pivot при клике на множество. Специальное значение __count__ может использоваться, чтобы задействовать измерение счета.

    <aggregate name="total_ojects" string="Total Objects" field="id" group_operator="count" measure="__count__"/>
  • clickable (необязательный атрибут)
    Логическое значение, указывающее, должено ли это множество быть кликабельным или нет (по умолчанию true). Нажатие на кликабельное множество изменит показатели, используемые вложенными представлениями, и добавит значение атрибута домена (если есть) в представление Search.
  • value_label (необязательный параметр)
    Строка, расположенная справа от значения множества. Например, может быть полезно указать его единицу измерения.
formula

объявляет производное значение. Формулы - это значения, рассчитанные из множеств.

Обратите внимание, что как и множества, формулы должны использоваться внутри тега группы (иначе стиль не будет применен должным образом).

Допустимые атрибуты:

  • value (обязательный атрибут)
    Строковое выражение, которое будет исполнятся с помощью встроенного средства запуска Python (в веб-клиенте). Каждое множество может использоваться в контексте переменной record. Например, record.price_total / record.order_id.
  • name (необязательный атрибут)
    Строка идентифицирующая данную формулу
  • string (необязательный атрибут)
    Краткое описание которое будет отображаться поверх формулы.
  • col (необязательный атрибут)
    Количество столбцов, охватываемых этим тегом (имеет смысл только внутри группы). По умолчанию 1.
  • widget (необязательный параметр)
    Виджет для форматирования значения (как, атрибут widget для полей). Например, monetary. По умолчанию это float.
  • help (необязательный параметр)
    Справочное сообщение для отображения во всплывающей подсказке (эквивалент параметра help для поля в Python)
  • value_label (необязательный параметр)
    Строка, расположенная справа от значения формулы. Например, может быть полезно указать единицу измерения значения формулы.
widget

Объявляет специализированный виджет, который будет использоваться для отображения информации. Этот механизм похож на виджеты в представлении Form.

Допустимые атрибуты:

  • name (обязательный параметр)
    Строка, определяющая, какой виджет должен быть создан. Представление будет смотреть в ` widget_registry``, чтобы получить правильный класс.
  • col (необязательный атрибут)
    Количество столбцов, охватываемых этим тегом (имеет смысл только внутри группы). По умолчанию 1.

Cohort

Представление Cohort используется для отображения и понимания того, как некоторые данные изменяются в течение определенного периода времени. Например, представьте, что для данного бизнеса клиенты могут подписаться на какой-либо сервис. Затем в представлении Cohort может отображаться общее количество подписок в месяц и изучаться частота, с которой клиенты отказываются от использования сервиса (отток). Если кликнуть на ячейку, представление Cohort перенаправит вас на новое действие, в котором вы увидите только записи, содержащиеся во временном интервале ячейки; это действие содержит представление List и представление Form.

Вот пример простого определения представления Cohort:

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

Корневым элементом представления Cohort является <cohort>, он принимает следующие атрибуты:

  • string (обязательный атрибут)
    Описание представления
  • date_start (обязательный атрибут)
    Валидное поле date или datetime. Это поле понимается представлением как дата начала записи
  • date_stop (обязательный атрибут)
    Валидное поле date или datetime. Это поле понимается представлением как дата окончания записи. Это поле, которое будет определять отток (churn).
  • mode (необязательный атрибут)
    Строка для описания режима. Это может быть либо churn, либо``retention`` (по умолчанию). Режим churn будет начинаться с 0% и накапливаться со временем, тогда как retention будет начинаться с 100% и уменьшаться со временем.
  • timeline (необязательный атрибут)
    Строка для описания временной шкалы. Значение может быть либо backward, либо forward (по умолчанию). forward будет отображать данные от date_start до date_stop, тогда как forward будет отображать данные от date_stop до date_start (когда date_start находится в будущем/дальше чем date_stop).
  • interval (необязательный атрибут)
    Строка для описания временного интервала. Может принимать значения day, week, month (по умолчанию) или year.
  • measure (необязательный атрибут)
    Поле, которое можно агрегировать. Это поле будет использоваться для вычисления значений для каждой ячейки. Если не определено, то представление Cohort просто высчитает количество вхождений.

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. When clicking on a cell, a detailed description of all activities of the same type for the record is displayed.

For example, here is a very simple Activity view:

<activity string="Activities"/>

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

  • string (обязательный атрибут)
    Описание представления

Значения Search по умолчанию

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. For instance, assuming foo is a field and bar is a filter an action context of:

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

автоматически активирует фильтр bar и ищет поле foo для acro.

QWeb

QWeb views are standard QWeb templates inside a view’s arch. They don’t have a specific root element.

A QWeb view can only contain a single template4, and the template’s name must match the view’s complete (including module name) external id.

template should be used as a shortcut to define QWeb views.

[1] for backwards compatibility reasons
[2] добавлена функция расширения для более простого поиска в представлениях QWeb: hasclass(*classes) узел будет попадать под выборку, если он узел имеет все указанные классы
[3] По историческим причинам он имеет свое происхождение из древовидных представлений, позже переориентированных на отображение большего таблиц/списков
[4] or no template if it’s an inherited view, then it should only contain xpath elements