¶ Форма
Отображает результат как форму с блоками.
Если в результате больше одной строки, то для каждой будет отрисована своя форма.
Форма является контейнером для полей с данными, а так же для других представлений - на одной форме можно разместить несколько вложенных таблиц, канбан-досок, таймлайнов, а также добавить отображения графиков, карт и прочих компонентов с помощью iframes.
SELECT
@type = 'form',
@title = 'Отчет',
@block_sizes = array[
6, 6
],
SUM(amount) as sum_amount @{
caption = 'Сумма (за все время)',
form_block = 0
},
{
ref: &crm.sales_report_table,
args: {
date_from: $$transaction_time - '1 month'::interval,
date_to: $$transaction_time
}
} as sales @{
control = 'user_view',
form_block = 1,
},
FROM crm.sales
¶ Содержание
- Атрибуты
- Атрибуты представления
block_sizesbuttonscreate_buttonscreate_linkdisable_auto_saveexport_to_csvextra_actionshelp_embedded_page_namehelp_pagelazy_loadmax_widthpanel_buttonspost_create_linkshow_argument_buttonshow_argument_editortitletype - Атрибуты колонок
captioncontrol_heightform_blockvisible - Атрибуты ячеек
cell_colorcell_variantcontroldefault_valueextra_select_viewsfraction_digitslinknumber_formatoptions_viewreferenced_entityselect_viewshow_secondssoft_disabledtext_aligntext_type
- Атрибуты представления
- Пример кода представления
Обозначения:
⚠️ - атрибут устарел (deprecated) и больше не поддерживаетсяИспользование:
Атрибуты представления и атрибуты строк начинаются с@и могут быть указаны в любом месте блокаSELECT
Атрибуты колонок и ячеек указываются после поля в блокеSELECTв форматеfield_name @{ attribute = value }
¶ Атрибуты представления ("форма")
¶ block_sizes
- Тип: Массив чисел
- Описание: Количество и ширина блоков на форме. Ширина задаётся в относительных величинах. Позволяет задавать столбцы на форме и использовать простую вёрстку.
- Значение по умолчанию:
[]
// отображение в две строки по три колонки
@block_sizes = array[
4, 4, 4,
4, 4, 4
]
// отображение в две строки, на первой две колонки, на второй - одна во всю ширину
@block_sizes = array[
4, 8,
12
]
¶ buttons
- Тип: Массив кнопок
- Описание: Дополнительные кнопки в "кебаб-меню" и в шапке представления.
@buttons = [
{
caption: 'Сгенерировать действия',
action: {
schema: 'crm',
name: 'gerenate_actions'
},
args: {
id: $id,
type: 'Звонок'
},
icon: 'flag',
display: 'desktop',
variant: 'info'
}
]
¶ create_buttons
- Тип: Массив кнопок
- Описание: Используется в случаях, когда нужно поддерживать несколько способов создания записи (заменяет
create_link). Добавляет выпадающий список с кнопками в шапку таблицы и "кебаб-меню".
@create_buttons = [
{
caption: 'Новый Человек',
new: true,
ref: &base.person_form,
default_values: {
is_client: true
},
icon: 'person_add_alt_1'
},
{
caption: 'Новая Организация',
ref: &base.organization_form,
new: true,
default_values: {
is_client: true
},
icon: 'add_business'
]
¶ create_link
- Тип: Действие
- Описание: Ссылка на представление для создания новых записей. Создаёт кнопку "Создать новую запись" в "кебаб-меню" и кнопку "+" в шапке таблицы.
@create_link = {
ref: &base.person_form,
default_values: {
is_client: true
}
}
¶ disable_auto_save
- Тип: Логическое
- Описание: Отключает автоматическое сохранение по таймеру, пока представление на экране. При этом сохранение всё равно произойдет при переходе на другое представление. Сохранение всегда отключено в представлениях, на главной сущности которых имеются триггеры.
- Значение по умолчанию:
false
@disable_auto_save = true,
¶ export_to_csv
- Тип: Логическое
- Описание: Включает возможность экспорта данных этого представления в CSV файл.
- Значение по умолчанию:
false
@export_to_csv = true,
Подробнее: Экспорт в csv в ozma.io
¶ extra_actions ⚠️
- Тип: Массив действий
- Описание: Дополнительные кнопки в "кебаб-меню" сверху.
⚠️ Больше не поддерживается (см.buttons).
¶ help_embedded_page_name ⚠️
- Тип: Строка
- Описание: Название страницы со справкой (см.
help_page).
⚠️ Больше не поддерживается (см.help_page).
¶ help_page
- Тип: Cсылка
- Описание: Ссылка на страницу-подсказку (
funapp.embedded_pages).
@help_page = {
schema: 'admin',
name: 'help__admin__main'
},
Подробнее: Справки, туториалы и поддержка
¶ lazy_load
- Тип: Объект
- Описание: Использование постраничной загрузки и отображения данных.
требуется обновление страницы браузера после установки нового значения lazy_load
// разбивает данные на страницы по 10 записей.
@lazy_load = {
pagination: {
per_page: 10
}
}
¶ max_width
- Тип: Число или строка
- Описание: Задаёт максимальную ширину формы. Может быть числом (опционально с
px), либо строкой с числом и%. Примеры:500,'500','500px'(ширина 500 пикселей),'100%'(ширина экрана). - Значение по умолчанию:
'1140px'
// 500 пикселей
@max_width = 500,
-- @max_width = '500',
-- @max_width = '500px',
// ширина экрана
@max_width = '100%',
Подробнее: Задание ширины формы с помощью
@max_width
¶ panel_buttons ⚠️
- Тип: Массив действий
- Описание: Дополнительные кнопки на верхней панели представления (см.
buttons).
⚠️ Больше не поддерживается (см.buttons)
¶ post_create_link
- Тип: Действие с идентификатором
- Описание: Действие, которое осуществляется после сохранения новой записи
@post_create_link = &pm.action_additional_form,
Подробнее: Открытие другого представления после сохранения новой записи
¶ show_argument_button
- Тип: Логическое
- Описание: Отображение кнопки "Фильтры", которая открывает редактор аргументов по клику на нее.
- Значение по умолчанию:
false
@show_argument_button = true,
Подробнее: Редактор аргументов
¶ show_argument_editor
- Тип: Логическое
- Описание: Отображение редактора аргументов по умолчанию.
- Значение по умолчанию:
false
@show_argument_editor = true,
Подробнее: Редактор аргументов
¶ title
- Тип: Строка
- Описание: Заголовок представления.
- Значение по умолчанию: Cистемное название представления.
@title = 'Сделки',
¶ type
- Тип: Строка [
'type'|'table','form','board','menu','timeline','multiselect'] - Описание: Тип пользовательского представления.
- Значение по умолчанию:
'table'
¶ Атрибуты колонок на форме
¶ caption
- Тип: Строка
- Описание: Название колонки.
- Значение по умолчанию: Название колонки из запроса.
name @{
caption = 'Имя'
}
¶ control_height
- Тип: Число
- Описание: Высота поля ввода многострочного текста или вложенного представления, в пикселях.
notes @{
text_type = 'multiline',
control_height = 300
},
¶ form_block
- Тип: Число
- Описание: Номер блока, к которому привязывается эта колонка.
- Значение по умолчанию:
0
status @{
form_block = 1
}
¶ visible
- Тип: Логическое
- Описание: Видимость колонки.
Вместе сdefault_valueпозволяет задать значения по умолчанию для создаваемых строк, которые скрыты от пользователя. - Значение по умолчанию:
true
created_on @{
visible = false,
}
¶ Атрибуты ячеек на форме
¶ cell_color ⚠️
- Тип: Цвет
- Описание: Цвет ячейки. (
⚠️ Больше не поддерживается (см.cell_variant)
¶ cell_variant
- Тип: Вариант
- Описание: Вариант ячейки (см. color-variants). При использовании
@cell_variantв качестве атрибута cтрок, окрашиваются все ячейки строк.
// окрашивает все строки
@cell_variant = 'secondary',
status @{
// окрашивает ячейку со статусом Завершено
cell_variant = CASE WHEN status = 'done' THEN 'success' END
}
Подробнее: Цветовые варианты и настройка тем ozma.io
¶ control
- Тип: Строка (
'user_view'|'iframe') - Описание: Указывает на используемый компонент.
- При значении
user_viewвместо ячейки отображается вложенное отображение, соответствующее значению ячейки, интерпретированному как ссылка с идентификатором. - При значении
iframeвместо ячейки отображается айфрейм, и значение передаётся в него.
- При значении
// user_view
{
ref: &admin.users_table,
args: { }
} as users @{
control = 'user_view'
}
// iframe
( SELECT full_name, amount FROM crm.clients ) as clients_amount @{
control = 'iframe',
iframe_markup = {
schema: 'admin',
name: 'stacked_multibar_chart'
}
}
¶ default_value
- Тип: Любое
- Описание: Значение по умолчанию для данной колонки. Обладает бóльшим приоритетом чем значение
defaultдля колонки в её определении.
¶ extra_select_views
- Тип: Массив ссылок с идентификатором
- Описание: Ссылки на отображения, с помощью которых возможно выбирать или создавать связанные значения для этой сущности. Отображения можно вызвать через кнопку внизу списка для значений поля. Обязателен дополнительный атрибут
"name": 'Название действия'.
client @{
extra_select_views = [
{ name: 'Человек', new: true, ref: &crm.person_form },
{ name: 'Организация', new: true, ref: &crm.organization_form }
]
}
¶ fraction_digits
- Тип: Число
- Описание: Работает только вместе с
number_format. Указывает, сколько цифр после запятой отображать. Не работает на формах для редактируемых полей.
SUM(amount) as sum_amount @{
number_format = 'ru',
fraction_difits = 2
}
¶ link
- Тип: Действие с идентификатором
- Описание: Представление, на которое происходит переход, или действие, которое осуществляется при нажатии на плашку в ячейке
user @{
link = &admin.user_form
}
¶ number_format
- Тип:
auto,en,ru - Описание: Формат отображения значений типов
intиdecimal. При значенииautoформат выберется на основе языка браузера пользователя.
// 'ru': 123 456,789
SUM(amount) as sum_amount @{
number_format = 'ru',
fraction_digits = 3
}
// 'en': 123,456.789
SUM(amount) as sum_amount @{
number_format = 'en',
fraction_digits = 3
}
¶ options_view
- Тип: Cсылка
- Описание: Ограничивает список возможных сущностей только теми, которые есть в представлении по ссылке.
Представление обязано иметь колонкиvalue(значения в которой равныidсущностей, которые можно выбрать) иpun, содержащую строки-лейблы, используемые для отображения опций вместо главной колонки сущности.
responsible_person @{
options_view = &base.employees_view
}
// base.employees_view
SELECT id as value, __main as pun
FROM base.people
WHERE is_client
ORDER BY __main
¶ referenced_entity ⚠️
- Тип: Ссылка
- Описание: Ссылка на сущность для использования с
options_view.
⚠️ Больше не используется
¶ select_view
- Тип: Ссылка с идентификатором
- Описание: Частный случай
extra_select_views. Кнопка для выбора связанной сущности из отображения. Удобна, когда не требуется кастомизация надписи на кнопке и кнопка только одна.
client @{
select_view = {
ref: &base.client_form,
new: true,
default_values: {
is_client: true
}
}
}
¶ show_seconds
- Тип: Логическое
- Описание: Показывать ли секунды в ячейках типа
datetime. - Значение по умолчанию:
false
created_on @{
show_seconds = true
}
¶ soft_disabled
- Тип: Логическое
- Описание: Если
true, то ячейку нельзя редактировать.- Важно: Данный атрибут отключает редактирование только на уровне интерфейса. Для более серьёзных ограничений необходимо использовать права доступа.
- Значение по умолчанию:
false
orders.delivery_date @{
soft_disabled = (orders.status = 'on_delivery')
}
¶ text_align
- Тип: Строка [
left|center|right] - Описание: Выравнивание содержимого ячейки по левому краю, по центру, по правому краю соответственно.
- Значение по умолчанию:
- для чисел:
right, - для остальных типов:
left
- для чисел:
amount @{
text_align = 'left'
},
name @{
text_align = 'center'
}
¶ text_type
- Тип: Строка
- Описание: Указывает на тип компонента для строчного значения. Возможные типы компонентов
actions.description @{
text_type = 'markdown'
}
Подробнее: Как включить форматирование текста в ozma.io
¶ Пример создания "формы"
-- Для отображения одной записи на форме необходимо передать в нее
-- идентификатор записи $id и обработать выборку этой записи условием в блоке WHERE
(
$id reference(public.entities)
):
SELECT
@type = 'form', -- Как отображать результат
@title = 'Entity: ' || $id=>name,
@block_sizes = array[ -- Разметка блоков на форме
4, 8,
12
],
@disabled_auto_save = true,
@max_width = '100%',
@buttons = [{
name: 'Архивировать',
icon: 'edit',
action: &admin.archive_record,
visible: NOT $id=>is_archived,
args: {
id: $id,
is_archived: true
},
display: 'desktop'
}, {
name: 'Убрать из архива',
icon: 'edit',
action: &admin.archive_record,
visible: $id=>is_archived,
args: {
id: $id,
is_archived: false
},
display: 'desktop'
}, {
name: 'История изменений',
icon: 'change_history',
ref: &admin.change_history,
args: {
schema: 'public', name: 'entities', id: $id
}
}],
schema_id @{
form_block = 0, -- Индекс блока, в котором расположить поле-инпут
soft_disabled = $id=>is_archived,
cell_variant = CASE WHEN $id=>is_archived THEN 'light' END
},
name @{
form_block = 0,
soft_disabled = $id=>is_archived,
cell_variant = CASE WHEN $id=>is_archived THEN 'light' END
},
main_field @{
form_block = 1,
soft_disabled = $id=>is_archived,
cell_variant = CASE WHEN $id=>is_archived THEN 'light' END
},
-- Вложенные представления на форме
{
ref: &admin.unique_constraints_table,
args: { id: $id }
} as unique_constraints @{
control = 'user_view',
form_block = 0,
-- Указание caption в родительской форме заменит title из вложенного представления.
-- Значение caption будет отображаться и на форме создания, и на форме редактирования---- записи.
caption = 'Unique Constraints'
},
{
ref: &admin.column_fields_table,
args: { id: $id }
} as column_fields @{
control = 'user_view',
form_block = 1,
caption = 'Column Fields'
},
FROM
public.entities
WHERE
id = $id
FOR INSERT INTO
public.entities
¶ Смотреть также
- Веб приложение FunApp - общая статья про все типы пользовательских представлений
- Таблица - отображение результата в виде таблицы
- Канбан-доска - отображение результата как канбан-доски с карточками
- Меню - отображение результата как набора ссылок
- Дерево - отображение результата как таблицы с древовидной структурой
- Таймлайн - отображение результата в виде лога событий и комментариев
- Мультиселект - отображение результата в виде нескольких значений в одном контроле