Представления определяют, как записи будут отображаться для конечных пользователей. Они определяются с помощью XML, это означает, что они могут редактироваться независимо от моделей, которые они представляют. Они очень гибкие и позволяют настраивать отображения моделей, которыми они управляют, на очень высоком уровне. Существуют различные типы представлений. Каждое из них представляет определенный режим отображения: form, list, kanban и т.д.
Общая структура
Базовые представления обычно имеют общую структуру, определенную ниже. Необходимые значения записаны заглавными буквами.
<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>
Поля
Объекты представлений это набор полей в специальной модели, они являются необязательными, если явно не указано иное.
name
(обязательный параметр)Char
полезно только в качестве понятного человеку описания представления для обращения к конкретному представлению среди множества подобных.
model
Char
Модель, связанная с представлением, если такое возможно.
priority
Integer
Когда представление запрашивается с помощью
(model, type)
, будет возвращено представление, соответствующее модели и типу, с самым низким приоритетом (это представление по умолчанию).Данный параметр также определяет порядок применения представлений во время наследования представлений.
groups_id
Many2many
->odoo.addons.base.models.res_users.Groups
Группы пользователей, которым будет разрешение использовать данное представление.
Если представление расширяет существующее представление, расширение будет применяться только для данного пользователя, если пользователь имеет доступ к предоставленному
groups_id
.arch
Text
Описание шаблона представления.
Attributes
Различные типы представлений имеют широкий спектр атрибутов, позволяющих настраивать их поведение. Про некоторые атрибуты мы здесь и расскажем. Не все они влияют на все типы представлений.
Примечание
Текущий контекст и права доступа пользователя также могут влиять на возможности представления.
create
Запретить/разрешить создание записи в представлении.
edit
(form
&list
&gantt
)Запретить/разрешить редактирование записи в представлении.
delete
(form
&list
)Запретить/разрешить удаление записи в представлении с помощью выпадающего списка Действий.
duplicate
(form
&list
)Запретить/разрешить дублирование записи в представлении с помощью выпадающего списка Действий.
decoration-$
(list
&gantt
)Позволяет изменять стиль текста строки на основе атрибутов соответствующей записи.
Значения - это выражения Python. Для каждой записи выражение оценивается с атрибутами записи как значения контекста и если
true
, соответствующий стиль применяется к строке. Другими контекстными значениями являютсяuid
(id текущего пользователя) иcurrent_date
(текущая дата в виде строки формыYYYY-MM-DD
).<tree decoration-info="state == 'draft'" decoration-danger="state == 'help_needed'" decoration-bf="state='busy'"> <TREE_VIEW_CONTENT> </tree>
Предупреждение
Поддерживаемые значения различаются для двух типов представлений. Представление типа Gantt поддерживает только
success
,info
,warning
,danger
иsecondary
. Представление типа list поддерживаетbf
,it
,success
,info
,warning
,danger
,muted
andprimary
.banner_route
адрес url маршрута, который нужно запросить и добавить к представлению.Если этот атрибут установлен то данный url контроллера будет запрошен и отображен поверх представления. Ответ json от контроллера должен содержать ключ «html».
Если html содержит тег <link> таблицы стилей, он будет удален и добавлен в <head>.
Для взаимодействия с бекэндом вы можете использовать теги <a type=»action»> . Пожалуйста обратите внимание в документации на метод _onActionClicked класса AbstractController (addons/web/static/src/js/views/abstract_controller.js) для того чтобы узнать об этом поподробнее.
Только те представления, которые расширяют AbstractView и AbstractController могут использовать атрибуты, например такие как Form, Kanban, List, …
Пример:
<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> """ }
Наследование
Поля которые используются для наследования
Два поля View
используются для определения наследования представлений.
Соответствие представления
- если представление запрашивается по
(model, type)
, то идет сопоставление с моделью, типом,mode = primary
и выбирается представление с самым низким приоритетом. - когда представление запрашивается по
id
, если его режим не являетсяprimary
, то сопоставляется его ближайший родитель с режимомprimary
.
Разрешение представления
Разрешение генерирует финальный arch
для запрошенного/совпадающего primary
представления:
- если представление имеет предка и родительский элемент полностью опознан, тогда применяются спецификации наследования текущего представления
- Если у представления нет родителя, его
arch
используется как есть - дочерние элементы текущего представления с режимом
extension
ищутся, и их спецификации наследования применяются сначала в глубину (применяется дочернее представление, затем его дочерние элементы, затем его родные элементы)
Результатом применения представлений дочерних элементов является финальный вариант arch
Определение наследования
Определение наследования состоит из элемента локатора, для поиска наследуемого элемента в родительском представлении и дочернего элемента, который будет использоваться для изменения унаследованного элемента.
Существует три типа локаторов для поиска целевого элемента:
- директива
xpath
с атрибутомexpr
.expr
- выражение XPath expression1 , примененное к текущемуarch
, первый узел, который он находит и является искомым - директива
field
с атрибутомname
, находит первое вхождениеfield
с тем жеname
. Все остальные атрибуты игнорируются при совпадении - любой другой элемент: первый элемент с тем же именем и идентичными атрибутами (игнорируются атрибуты
position
иversion
) и будет искомым
<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>
Определение наследования может иметь необязательный атрибут position
, определяющий, каким образом должен быть найден нужный узел для дальнейшего изменения:
inside
(по умолчанию)- содержимое определенного наследования добавляется к найденному узлу
replace
- содержимое определенного наследования заменяет найденный узел. Любой текстовый узел, содержащий только
$ 0
внутри содержимого спецификации, будет заменен полной копией найденного узла, эффективно обернув найденный узел. after
- содержимое определенного наследования добавляется к родительскому элементу найденного узла сразу после этого узла
before
- Содержимое определения наследования добавляется к родительскому элементу найденного узла перед ним
attributes
в определении наследования должны быть элементы
attribute
с атрибутомname
и содержимым, наличие которого не является обязательным:- если у элемента
attribute
есть содержимое, в найденном узле создается новый атрибут, после егоname
, с текстом элементаattribute
как значением - если у элемента
attribute
нет тела, атрибут, указанный после егоname
, удаляется из найденного узла. Если такой атрибут отсутствует, возникает ошибка
<field name="sale_information" position="attributes"> <attribute name="invisible">0</attribute> <attribute name="attrs"> {'invisible': [('sale_ok', '=', False)], 'readonly': [('editable', '=', False)]} </attribute> </field>
- если у элемента
move
может использоваться как прямой потомок определения наследования с атрибутом
inside
,replace
,after
илиbefore
position
для замены узла.<xpath expr="//@target" position="after"> <xpath expr="//@node" position="move"/> </xpath> <field name="target_field" position="after"> <field name="my_field" position="move"/> </field>
Определения представления применяются последовательно.
hasclass(*classes)
узел будет попадать под выборку, если он узел имеет все указанные классыТипы представлений
Activity
Представление «Activity » используется для отображения действий, связанных с записями. Данные отображаются на диаграмме с записями, образующими строки, а типы действий - столбцами. Первая ячейка каждой строки отображает (это настраиваемое представление , смотрите templates
, оно очень похоже на Kanban) карточку представляющую соответствующую запись. При нажатии на другие ячейки отображается подробное описание всех действий того же типа для записи.
Предупреждение
Представление Activity доступно только тогда, когда установлен модуль mail
, и остальные модели наследуют mail.activity.mixin
.
Корневым элементом представления Activity является <activity>
, и он принимает следующие атрибуты:
string
(обязательный атрибут)- Описание представления
Допустимые дочерние элементы представления:
field
объявляет поля для использования в представлении что логично. Если поле просто отображается в представлении Activity , его не нужно предварительно объявлять.
Допустимые атрибуты:
name
(обязательный атрибут)- имя требуемого поля
templates
Определяет список шаблонов reference / qweb. Определение карточек может быть разбито на несколько шаблонов для большей наглядности, но представления Activity должны определять хотя бы один корневой шаблон
activity-box
, который будет отображаться один раз для каждой записи.Представление Activity использует стандартнный javascript qweb и предоставляет следующие переменные контекста (см Kanban для более детального изучения):
widget
- текущий
ActivityRecord()
, может быть использован для извлечения некоторой метаинформации. Эти методы также доступны непосредственно в контексте шаблона и не требуют доступа черезwidget
record
- объект атрибутами которого являются запрошенные поля. Каждое поле имеет два атрибута
value
иraw_value
Calendar
Представление Calendar записи как события в однодневном, недельном или месячном календарях. Его корневым элементом является <calendar>
. Допустимыми атрибутами в представлении Calendar являются:
date_start
(обязательный атрибут)- имя поля записи, содержащее дату начала события
date_stop
- имя поля записи, содержащее дату окончания события, если указана
date_stop
, записи становятся подвижными (с помощью перетаскивания) непосредственно в представлении Calendar date_delay
- альтернатива
date_stop
, указывает продолжительность события, а не его дату окончания (едица: день) color
- имя поля записи, используемое для цветового разделения. Записи в одного сегмента в представлении Calendar подсвечиваются тем же цветом, значения цветов распределяются псевдо-случайным образом. На боковой панели отображается легенда
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
используйте «True» чтобы скрыть значение в карточкеavatar_field
только для x2many поля, показывать аватар в видеdisplay_name
в карточкахwrite_model
иwrite_field
вы можете добавить фильтр и сохранить результат в определенной модели, фильтр добавляется на боковой панели
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
- название говорит само за себя
Cohort
Enterprise featureПредставление Cohort используется для отображения и понимания того, как некоторые данные изменяются в течение определенного периода времени. Например, представьте, что для данного бизнеса клиенты могут подписаться на какой-либо сервис. Затем в представлении Cohort может отображаться общее количество подписок в месяц и изучаться частота, с которой клиенты отказываются от использования сервиса (отток). Если кликнуть на ячейку, представление Cohort перенаправит вас на новое действие, в котором вы увидите только записи, содержащиеся во временном интервале ячейки; это действие содержит представление List и представление Form.
Примечание
По умолчанию в представлении Cohort будет использоваться те же представления List и Form, что и в действии. Вы можете передать представление List и представление Form в контекст действия, чтобы установить/переопределить представления, которые будут использоваться (ключи контекста для переопределения form_view_id
и list_view_id
)
Вот пример простого определения представления 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 просто высчитает количество вхождений.
Dashboard
Enterprise featureКак представления 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 `` равно «».Примечание
Специальная агрегатная функция
count_distinct
(определенная в odoo) может быть здесь задействована<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.
Diagram
Предупреждение
Представление Diagram не будет поддерживаться saas-13.1
и последующих версиях!
Представление 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
выводится как параграф в заголовке диаграммы.
Form
Представления Form используются для отображения данных одной записи. Их корневой элемент - <form>
. Они состоит из обычного HTML с дополнительными структурными и семантическими компонентами.
Структурные компоненты
Структурные компоненты обеспечивают структуру или «визуальные» функции с небольшим количеством логики. Они используются как элементы или наборы элементов в представлениях Form.
notebook
определяет секцию с вкладками. Каждая вкладка определяется через дочерний элемент
page
.page
элементы могут иметь следующие атрибуты:string
(обязательный атрибут) название вкладкиaccesskey
HTML атрибут accesskeyattrs
стандартные динамические атрибуты основанные на значениях записей
Примечание
Помните что
notebook
не должен находится внутриgroup
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
закрывает без сохранения. confirm
- confirmation message to display (and for the user to accept) before performing the button’s Odoo call (also works in Kanban views).
field
отображает (и,возможно, разрешает редактирование) единственное поле текущей записи. Поддерживается множественное использование параметра
field
представлением Form, данный параметр может получать различные значения для модификаторовinvisible
иreadonly
. Однако поведение не гарантируется, когда существует несколько полей с различными значениями для модификатораrequired
. Возможные атрибуты узлаfield
: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_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
хранит пароль и что его данные не должны отображаться kanban_view_ref
- для открытия определенного представления Kanban когда выбираются записи из m2o/m2m в мобильном варианте
Общая структура
<form>
<sheet>
<header>
<field name="state" widget="statusbar"/>
</header>
<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 предназначены для формирования диаграмм Ганта (они, как правило, применяются для планирования).
Корневым элементом представлений Gantt является ``<gantt /> ``, у него нет потомков, но он может принимать следующие атрибуты:
date_start
(обязательный атрибут)- Имя поля, указывающего на дату начала события для каждой записи.
date_stop
(обязательный параметр)- имя поля, указывающего на дату окончания события для каждой записи.
color
- имя поля, используемого для сопоставления цвета «плашки» со значением поля
decoration-{$name}
позволяют изменять стиль текста строки на основе атрибутов связанной записи.
Значения - это выражения Python. Для каждой записи выражение вычисляется по атрибутам записи как значениям контекста и если вычисление возвращает
true
, то соответствующий стиль применяется к строке. Другими значениями контекста являютсяuid
(id текущего пользователя) иcurrent_date
(текущая дата в виде строки формыyyyy-MM-dd
).{$name}
может быть одним из следующих bootstrap цветов (danger
,info
,secondary
,success
orwarning
).default_group_by
- имя поля для группировки задач
consolidation
- имя поля для отображения значения консолидации в ячейке записи
consolidation_max
- словарь с полем
group by
в качестве ключа и максимальное значение консолидации, которое может быть достигнуто до отображения ячейки красным цветом (например,{"user_id": 100}
) consolidation_exclude
- имя поля, которое описывает, нужно ли исключать задачу из консолидации, если задано значение true, в строке консолидации отображается полосатая зона
create
,edit
,plan
позволяет disизменять соответствующее действие в представлении, устанавливая соответствующий атрибут на
false
.create
: Если разрешено, то «+» кнопка будет отображаться при наведении на временной интервал, чтобы создать новую запись в этом интервале, и еслиedit
: если включено, открытые записи будут в режиме редактированияplan
: если разрешено и разрешеноedit
, то кнопка «увеличительное стекло» будет отображаться на временных интервалах, чтобы планировать неназначенные записи в этот временной интервал.
Пример
Если вы не хотите создавать записи в представлении Gantt, а для модели требуются даты начала и окончания, функция планирования должна быть отключена, поскольку запись не будет найдена.
offset
- В зависимости от масштаба, количество единиц, добавляемых к сегодняшнему дню, для расчета периода по умолчанию. Примеры: смещение +1 на неделе
default_scale
откроет представление Gantt для следующей недели, а смещение -2 в месяцеdefault_scale
откроет представление Gantt 2 месяца назад. progress
- имя поля, предоставляющего процент завершения события записи, от 0 до 100
string
- Заголовок представления Gantt
precision
JSON-объект, указывающий точность привязки для «плашке» при изменении масштаба.
Допустимые значения для масштабирования это
day
(по умолчанию:hour
):hour
: время записи будет округляться в большую сторону до целого часа (к примеру: 7:12 станет 8:00)hour:half
: время записи будет округляться в большую сторону до получаса (например: 7:12 станет 7:30)hour:quarter
: время записи будет округляться в большую сторону до четверти часа (например: 7:12 станет 7:15)Допустимые значения масштаба -
week
(по умолчанию:day:half
):day
: время записи будет округляться до суток (например: 7:28 станет 23:59:59 предыдущего дня, а 22:32 станет 00:00 текущего дня)day:half
: время записи будет округляться следующим образом 7:28 AM станет 12:00 PMДопустимые значения для масштаба -
month
(по умолчанию:day:half
):day
: время записи будет округляться до суток (например: 7:28 станет 23:59:59 предыдущего дня, а 22:32 станет 00:00 текущего дня)day:half
: время записи будет округляться следующим образом 7:28 AM станет 12:00 PM- Масштаб
year
всегда округляется до полного дня.
Пример точности атрибута:
{"day": "hour:quarter", "week": "day:half", "month": "day"}
total_row
- параметр для того чтобы контролировать, должна ли отображаться строка, содержащая общее количество записей. (по умолчанию:
false
) collapse_first_level
- параметр для того, чтобы контролировать, можно ли свернуть каждую строку, если сгруппированы по одному полю. (по умолчанию:
false
, группировка начинается с двух полей) display_unavailability
- параметр для того, чтобы отметить даты возвращенные
gantt_unavailability
функции модели доступной внутри представления Gantt. Записи в них все еще могут быть запланированы, но их недоступность отображается визуально. (по умолчанию:false
) default_scale
режим отображения по умолчанию при рендеринге представления. Допустимые атрибуты (по умолчанию:
month
):day
week
month
year
scales
- разделенный запятыми список разрешенных шкал для этого представления. По умолчанию все шкалы разрешены. Допустимые значений масштаба для использования в этом списке, смотрите
default_scale
. templates
определяет QWeb шаблон
gantt-popover
который используется, когда пользователь наводит курсор на одну из записей в представлении Gannt.Представление Gantt использует стандартный javascript qweb и предоставляет следующие переменные контекста:
widget
- текущий
GanttRow()
, может использоваться для извлечения метаинформации. МетодgetColor
используется для преобразования в целого числа в цвет, также доступен непосредственно в контексте шаблона без использованияwidget
.
on_create
Если указано при нажатии кнопки «Добавить» в представлении, вместо открытия стандартного диалогового окна, запускает действие клиента. Должен быть указан xmlid действия (пример:on_create="%(my_module.my_wizard)d"
form_view_id
- представление Form, которое открывается, когда пользователь создает или редактирует запись. Обратите внимание, что если этот атрибут не установлен, представление Gannt будет обращаться к идентификатору представления Form в текущем действии, если оно есть.
thumbnails
Это позволяет отображать миниатюру рядом с названием группы, если группа является реляционным полем. Ожидается что Python определяет, какие ключи являются именем поля в активной модели. Значения - это имена полей, содержащих миниатюру в связанной модели.
Пример: задачи имеют поле
user_id
, которое ссылается наres.users
. Модельres.users
имеет поле с изображением, которое содержит аватар, а затем:<gantt date_start="date_start" date_stop="date_stop" thumbnails="{'user_id': 'image_128'}" > </gantt>
будет отображать аватары пользователей рядом с их именами, когда они сгруппированы по
user_id
.
Graph
Представление 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
)вместо группировки по указанному времени (фиксированные значения секунд) или дате (фиксированные значения дней).
измерения автоматически генерируются из полей модели; используются только агрегируемые поля. Эти измерения также сортируются в алфавитном порядке по строке поля.
Предупреждение
агрегирование представлений Graph выполняется по содержимому базы данных, не сохраняемые поля функций нельзя использовать в представлениях Graph
Kanban
Представление Kanban являет собой визуализацию канбан доску: она отображает записи как « карты», и призваны заполнить промежуточную нишу между представлением List и нередактируемым представлением Form. Записи могут быть сгруппированы в столбцы для использования для визуализации рабочего процесса или в его манипуляции (например для отображения задач или управления прогрессом работ) или не группироваться (используются просто для визуализации записей).
Примечание
Представление Kanban загрузит и отобразит не более десяти столбцов. Любой столбец после этого будет свернут (но все же может быть открыт пользователем).
Корневым элементом представления Kanban является <kanban>
, он может использовать следующие атрибуты:
default_group_by
- указывает на то, следует ли группировать представление Kanban, если группировка не указана с помощью действия или текущего поиска. Должно быть именем поля, по которому нужно группировать, если никакая другая группировка не указана
default_order
- порядок сортировки карточек, если пользователь еще не отсортировал записи (через представление List)
class
- добавляет HTML-классы к корневому элементу HTML представления Kanban
examples
- если установлен ключ KanbanExamplesRegistry, примеры настройки колонок будут доступны в режиме группировки представления Kanban. `Здесь<https://github.com/odoo/odoo/blob/99821fdcf89aa66ac9561a972c6823135ebf65c0/addons/project/static/src/js/project_task_kanban_examples.js#L27>`_ пример того как применить эти настройки.
group_create
- определяет видим ли элемент «Добавить новую колонку». По умолчанию:
true
. group_delete
- определяет могут ли группы быть удалены через контекстное меню. По умолчанию:
true
. group_edit
- определяет могут ли группы быть отредактированы через контекстное меню. По умолчанию:
true
. archivable
- определяет могут ли записи колонки быть заархивированы/восстановлены если поле
active
определено в модели. По умолчанию:true
. quick_create
- определяет следует ли создавать записи без переключения на представление Form. По умолчанию,
quick_create
включено, когда представление Kanban сгруппировано поmany2one
,selection
,char
илиboolean
полям и отключено, если нет. quick_create_view
- ссылка на представление Form, которая будет использоваться для быстрого создания записей.
records_draggable
определяет можно ли таскать записи когда представление Kanban находится в режиме группировки. По умолчанию:
true
.Установите
true
чтобы всегда разрешать, иfalse
всегда отключать.
Допустимые дочерние элементы представления:
field
объявляет поля для агрегирования или для использования в kanban *логике *. Если поле просто отображается в представлении Kanban, его не нужно предварительно объявлять.
Допустимые атрибуты:
name
(обязательный атрибут)- имя требуемого поля
progressbar
объявляет элемент прогрессбара, который будет находится сверху канбан колонки.
Допустимые атрибуты:
field
(обязательный параметр)- имя поля, значения которого используются для учета записей столбца в прогресбаре
colors
(обязательный параметр)- JSON отображение значений вышеуказанных полей в цвета
danger
,warning
,success
илиmuted
sum_field
(необязательный параметр)- имя поля, значения записей в столбце которого будут суммироваться и отображаться рядом с прогресбаром (если опущено, отображает общее количество записей)
templates
определяет список QWeb шаблонов. Определение карточек может быть разбито на несколько шаблонов для большей наглядности, но представления Kanban должны определять хотя бы один корневой шаблон
kanban-box
, который будет отображаться один раз для каждой записи.Представление Kanban использует в основном javascript qweb и предоставляет следующие контекстные переменные:
widget
- текущий класс
KanbanRecord()
, может быть испльзован для доступа к мета-информации. Эти методы так же доступны прямо из контекста шаблона и не требуют доступа черезwidget
record
- объект со всеми запрошенными полями в качестве атрибутов. Каждое поле имеет два атрибута
value
иraw_value
, первое форматируется в соответствии с текущими пользовательскими параметрами, второе является прямым значением изread()
(кроме полейdate
иdatetime
которые форматируются на базе локали пользователя) context
- текущий контекст, полученный из действия, и поле
one2many
илиmany2many
в случае представления Kanban, встроенного в представление Form user_context
- название говорит само за себя
read_only_mode
- название говорит само за себя
selection_mode
установите в значение true, когда представление Kanban открывается в мобильной среде из поля m2o/m2m для выбора записей.
Примечание
клик по полю m2o/m2m в мобильном окружении открывает представление Kanban
Кнопки и поля
Пока большинство Kanban шаблонов это стандартный QWeb, представление Kanban специальные элементы
field
,button
иa
:по умолчанию поля заменяются их форматированными значениями, если не указан атрибут
widget
, и в этом случае их отображение и поведение зависят от соответствующего виджета. Допустимые значения (среди прочих):handle
- для полей
sequence
(илиinteger
) чьи записи отсортированы, позволяет менять порядок сортировки с помощью drag&drop.
кнопки и ссылки с атрибутом
type
стали выполнять операции, связанные с Odoo, а не их стандартную функцию HTML. Возможные типы:action
,object
- стандартное поведение для Odoo buttons, можно использовать большинство атрибутов, относящихся к стандартным кнопкам Odoo.
open
- открывает запись карточки в представлении Form в режиме только для чтения
edit
- открывает запись карты в представлении Form в редактируемом режиме
delete
- удаляет запись карты и удаляет карту
Если вы хотите расширить представление Kanban смотрите :js:class::[UNKNOWN NODE title_reference].
List
Корневым элементом представления List является <tree>
2. Корень представления может иметь следующие атрибуты:
editable
по умолчанию выбор строки представления списка открывает соответствующее представление Form. Атрибуты
editable
дают возможность редактировать данные прямо в представлении List.Допустимыми значениями являются
top
иbottom
, в результате чего новые записи появляются соответственно в верхней или нижней части списка.Внутреннее устройство представление Form является производным представления List. Большинство атрибутов допустимы представлением Form, и точно таким же образом, кнопки принимаются представлениями List, хотя они могут не иметь никакого значения, если представление List недоступно для редактирования
Примечание
если атрибут
edit
определен какfalse
, то параметрeditable
будет игнорироваться.multi_edit
- редактируемый список или нет может активировать функция мультиредактирования через определение
multi_edit=1
default_order
переопределяет порядок сортировки представления, изменяя заданный по умолчанию порядок для модели (
_order
атрибут модели). Значение представляет собой список полей, разделенных запятой, с пометкойdesc
для сортировки в обратном порядке:<tree default_order="sequence,name desc">
decoration-{$name}
позволяют изменять стиль текста строки на основе атрибутов связанной записи.
{$name}
может бытьbf
(font-weight: bold
),it
(font-style: italic
), или любым другим bootstrap цветом (danger
,info
,muted
,primary
,success
илиwarning
).create
,edit
,delete
,duplicate
,import
,export_xlsx
- непозволяет изменять соответствующее действие в представлении, устанавливая нужный атрибут на
false
limit
- размер страницы по умолчанию. Должен иметь значение положительного
integer
groups_limit
- когда представление List сгруппировано, определяет число групп по умолчанию на странице. Должен иметь значение положительного
integer
expand
- когда представление List сгруппировано, автоматически открывается первый уровень групп, если установлено значение
true
(по умолчанию:false
)
Допустимыми дочерними элементами представления List являются:
Map
Enterprise featureЭто представление может отображать записи на карте и маршруты между ними. Запись представлена булавками. Это также позволяет визуализировать поля из модели во всплывающем окне, привязанному к булавке записи.
Примечание
Модель, к которой применяется представление, должна содержать поле many2one
со ссылкой на res.partner
, так как представление использует поля адреса res.partner
и координаты для локализации записей.
Api
Представление использует api платформ данных о местоположении для загрузки тайлов (фона карты),выполняя геоозапросы (преобразования адресов в набор координат) и загружает маршруты. Представление реализует два API, по умолчанию первое это OpenStreet Map может загружать тайлы и совершать геозапросы. Данный API не требует токена. Как только вы укажите в настройках токен MapBox то представление переключится на API Mapbox. Данный API быстрее и позволяет вычисление маршрутов. Токен будет доступен после регистрации на MapBox
Структурные компоненты
Корневым элементом представления Map является <map>
, который допускает использование следующих атрибутов
res_partner
- Содержит поле
many2one
со ссылкой наres.partner
. Если не указано, то представление создаст пустую карту. default_order
- Если поле существует, представление переопределит порядок сортировки модели по умолчанию. Поле должно быть частью модели, к которой применяется представление, а не из
res.partner
routing
- если
true
будут показаны маршруты между записями. Для представления все еще требуется действительный токен MapBox и как минимум две найденные записи. (то есть у записей полеmany2one
со ссылкой наres.partner
, а у партнера есть адрес или действительные координаты)
Единственный разрешенный элемент внутри <map>
это <marker-popup>
. Он может содержать несколько элементов <field>
. Каждый из которых будет интерпретирован как строка во всплывающем окне маркера. Атрибуты поля следующие:
name
- Поле для отображения.
string
- Эта строка будет отображаться перед содержимым поля. Может использоваться как описание.
Никакой атрибут или элемент не является обязательным, но, как указано выше, если не указано поле many2one
со ссылкой на res.partner
, представление не сможет найти записи.
- Вот пример представления Map:
<map res_partner="partner_id" default_order="date_begin" routing="true"> <marker-popup> <field name="name" string="Task: "/> </marker-popup> </map>
Pivot
Представление 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
, поле не появится в активных измерениях ни в выбираемых (полезно для полей, которые не имеет смысла агрегировать, такие как поля в разных единицах, например, € и $).
измерения автоматически генерируются из полей модели; используются только агрегируемые поля. Эти измерения также сортируются в алфавитном порядке по строке поля.
Предупреждение
так же как и представление Graph, Pivot делает выборку из базы данных, не сохраняемые поля функций нельзя использовать в представлениях Pivot
В представлении 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>
QWeb
Представления QWeb являются стандартным QWeb шаблоном внутри атрибута``arch``. У них нет определенного корневого элемента. Поскольку представления QWeb не имеют определенного корневого элемента, их тип должен быть указан явно (его нельзя вывести из корневого элемента поля arch
).
QWeb представления имеют два сценария применения:
- они могут быть использованы как шаблоны для фронтэнда, где template должен использоваться как ссылка.
- они могут использоваться как фактические представления qweb (открытые внутри действия), и в этом случае они должны быть определены как обычные представления с явным
type
(это не может быть выведено) и моделью.
Основные дополнения qweb-as-view перед qweb-as-template:
- qweb-as-view есть специальный сценарий для элемента
<nav>
содержащего классo_qweb_cp_buttons
: его содержимое должно быть кнопками и будет извлечено и перемещено в область кнопок панели управления, а элемент<nav>
будет удален, этот путь для контроля представлений панели пока не существует рендеринг qweb-as-view добавляет несколько элементов в стандартный контекст рендеринга qweb:
model
- имя модели, с которой связано представление Qweb
domain
- домен предоставляемый представлением Search
context
- контекст предоставляемый представлением Search
records
- ленивый прокси``model.search(domain)``, можно использовать, если вы просто хотите перебирать записи и не выполнять более сложные операции (такие как группировка)
qweb-as-view так же предоставляет дополнительные возможности рендеринга:
_qweb_prepare_context(view_id, domain)
подготавливает контекст рендеринга специально для qweb-as-viewqweb_render_view(view_id, domain)
это метод, вызываемый клиентом, который будет вызывать методы подготовки контекста и в конечном итогеenv['ir.qweb'].render()
.
Search
Представления Search отличаются от предыдущих типов представлений тем, что они не отображают *content *: хотя они применяются к определенной модели, они используются для фильтрации содержимого другого представления (как правило, е представления-агрегаторы, например List or Graph). Не смотря на это различие, они определяются одинаково.
Корневым элементом представлений поиска является <search>
. Он не принимает атрибутов.
Допустимые дочерние элементы в представлении Search:
field
Поля определяют домены или контексты со значениями, который вводят пользователи. Когда создаются поисковые домены, домены полей составляются друг с другом и с фильтрами, используя оператор AND.
Поля могут иметь следующие атрибуты:
name
- имя поля для фильтрации
string
- описание поля
operator
по умолчанию, поля генерируют домен по следующему шаблону
[(name, operator, provided_value)]
гдеname
имя поляprovided_value
значение предоставленное пользователем, возможно отфильтрованный или преобразованный (например, ожидается, что пользователь предоставит метку значения поляselection
, а не само значение).Атрибут
operator
позволяет переопределять оператор по умолчанию, который зависит от типа поля (например,=
для полей с типомfloat
, ноilike
для полей с типомchar
)filter_domain
полный домен, который можно использовать в качестве домена поиска поля, может использовать переменную
self
для вставки предоставленного значения в пользовательский домен. Может использоваться для генерации значительно более гибких доменов, чем только «оператор» (например, поиск по нескольким полям одновременно)Если указаны оба
operator
, иfilter_domain
, то приоритет имеетfilter_domain
.context
позволяет добавлять контекстные ключи, в том числе предоставляемое пользователем значение (которое, как и для
domain
, доступно как переменнаяself
,массив значений таких как[id_1, id_2]
для поляMany2one
). По умолчанию поля не генерируют домены.Примечание
домен и контекст включены и оба генерируются, если указан
context
. Чтобы только генерировать значения контекста, установитеfilter_domain
в пустой список:filter_domain = "[]"
groups
- сделать поле доступным только для определенных пользователей
widget
- используйте конкретный виджет поиска для поля (единственный случай использования в стандарте Odoo 8.0 - это виджет
selection
для полейMany2one
) domain
- если поле может обеспечить автодополнение (например
Many2one
), отфильтрует возможные результаты завершения.
filter
фильтр - это предопределенный переключатель в представлении Search, его можно включить или отключить. Его основная цель добавление данных в контекст поиска (контекст, передаваемый в представление данных для поиска/фильтрации), или для добавления новых разделов в фильтр поиска.
Фильтры могут иметь следующие атрибуты:
string
(обязательный параметр)- описание фильтра
domain
(необязательный параметр)- домен Odoo domain, будет добавлен к домену действия как часть поискового домена.
date
(необязательный параметр)имя поля имеющего тип
date
илиdatetime
. Использование этого атрибута позволяет создать набор фильтров, доступных в подменю меню фильтров. Предлагаемые фильтры зависят от времени, но не являются динамическими в том смысле, что их домены оцениваются во время создания панели управления.Пример:
<filter name="filter_create_date" date="create_date" string="Creation Date"/>
Приведенный выше пример позволяет легко искать записи по полю даты создания в один из следующих периодов (если текущий месяц август 2019 г).
Create Date > August July June Q4 Q3 Q2 Q1 -------------- 2019 2018 2017
Позволяет множественный выбор опций.
default_period
(необязательный параметр)имеет смысл только для фильтра с непустым атрибутом
date
. определяет, какой период активирован, если фильтр входит в набор фильтров по умолчанию, активируется при инициализации представления. Если значение не указано, по умолчанию используетсяthis_month
.Выбирайте среди следующих параметров:
today
,this_week
,this_month
,last_month
,antepenultimate_month
,fourth_quarter
,third_quarter
,second_quarter
,first_quarter
,this_year
,last_year
,antepenultimate_year
.Пример:
<filter name="filter_create_date" date="create_date" string="Creation Date" default_period="this_week"/>
context
словарь Python, объединенный с доменом действия для создания домена поиска
Ключ
group_by
может использоваться для определения группы, доступной в меню «Группировать по». Значениеgroup_by
может быть допустимым именем поля.<filter name="groupby_category" string="Category" context = {'group_by': 'category_id'}/>
Определенная выше группировка позволяет группировать данные по категориям.
Когда тип поля
date
илиdatetime
, фильтр генерирует подменю для меню «Группировать по», в котором доступны следующие параметры интервала:day
,week
,month
,quarter
,year
.Если фильтр находится в наборе фильтров по умолчанию, активированном при инициализации представления, записи по умолчанию сгруппированы по месяцам. Это можно изменить с помощью синтаксиса
date_field:interval
, как в следующем примере.Пример:
<filter name="groupby_create_date" string="Creation Date" context = {'group_by': 'create_date:week'}/>
Примечание
На результаты
read_groups
, сгруппированных по полю, может влиять его атрибутgroup_expand
, позволяющий при необходимости отображать пустые группы. Для получения дополнительной информации обратитесь к документации по атрибутамField
.name
- логическое имя фильтра, может использоваться для включить его по умолчанию, также может использоваться как hook наследования
help
- более длинный пояснительный текст для фильтра, может отображаться в виде всплывающей подсказки
groups
- делает фильтр доступным только для определенных пользователей
Совет
Добавлено в версии 7.0.
Последовательности фильтров (без разделения) рассматриваются как включенные композиции: они будут состоять из операторов
ИЛИ
, а не обычногоИ
.<filter domain="[('state', '=', 'draft')]"/> <filter domain="[('state', '=', 'done')]"/>
Если выбраны оба фильтра, выберет записи,
state
которых равенdraft
илиdone
, но<filter domain="[('state', '=', 'draft')]"/> <separator/> <filter domain="[('delay', '<', 15)]"/>
если выбраны оба фильтра, выберет записи,
state
которых являетсяdraft
иdelay
меньше чем 15.separator
- может использоваться для разделения групп фильтров в простых представлениях Search
group
- может использоваться для разделения групп фильтров, более читаемых, чем
separator
в сложных представлениях Search searchpanel
позволяет отображать панель поиска слева от любого представления нескольких записей. По умолчанию в представлениях List и Kanban включена панель поиска. Панель поиска можно активировать в других представлениях с атрибутом:
view_types
список типов представлений, разделенных запятыми, по умолчанию включена панель поиска для:tree,kanban
Этот инструмент позволяет быстро фильтровать данные на основе заданных полей. Поля указываются как прямые потомки
searchpanel
с именем тегаfield
и следующими атрибутами:name
(обязательный параметр) имя поля для фильтрацииselect
определяет поведение и отображение. Допустимые значенияone
(по умолчанию) можно выбрать не более одного значения. Поддерживаемые типы полей -many2one
иselection
.multi
можно выбрать несколько значений (чекебоксы). Поддерживаемые типы полей:many2one
,many2many
иselection
.
groups
: ограничения для определенных пользователейstring
: определяет название для отображенияicon
: определяет какую иконку использоватьcolor
: определяет цвет иконки
Дополнительные необязательные атрибуты доступны в случае использования
multi
:- определяет условия, которым должны удовлетворять записи
comodel
.
Домен может использоваться для выражения зависимости от другого поля (с
select = "one"
) панели поиска. Посмотрите<searchpanel> <field name="department_id"/> <field name="manager_id" select="multi" domain="[('department_id', '=', department_id)]"/> <searchpanel/>
В приведенном выше примере диапазон значений для manager_id (имена менеджеров), доступных на экране, будет зависеть от значения, выбранного в данный момент для поля
department_id
.groupby
: имя поляcomodel
(достумно только для полейmany2one
иmany2many
полей). Значения будут сгруппированы по этому полю.disable_counters
: по умолчаниюfalse
. Если установлено в `` true`` счетчики не будут вычислены.Эта функция была реализована на случай, если производительность будет слишком плохой.
Другой способ решения проблем с производительностью - правильно переопределить метод
search_panel_select_multi_range
.
Значения Search по умолчанию
Поля и фильтры поиска можно настроить с помощью контекста действия, используя ключи search_default_name
. Для полей значение должно быть значением, установленным в поле, для фильтров это логическое значение. Например, предполагая, что foo
является полем, а bar
- фильтром, контекст действия:
{
'search_default_foo': 'acro',
'search_default_bar': 1
}
автоматически активирует фильтр bar
и ищет поле foo
для acro.
Числовое значение (от 1 до 99) может использоваться для описания порядка групп по умолчанию. Например, если foo
и bar
относятся к двум группам
{
'search_default_foo': 2,
'search_default_bar': 1
}
будет активирован сначала bar
а затем foo
.