Представления
Этот раздел описывает действия с сущностями в схеме домена.
Интерфейс для работы с объектами позволяет просматривать и редактировать информацию об объектах, работать с различными визуальными элементами, а также выполнять действия с объектами. Описание интерфейса системы является частью схемы домена и включается в поле views на уровне домена.
В описаниях интерфейса используются ссылки на действия, меню домена, а также иконки для виджетов представлений и элементов меню.
| Ознакомьтесь с правилами нотации в схеме домена. Это позволит присваивать корректные названия создаваемым элементам схемы. Эти названия будут отображаться в интерфейсе системы. |
Структура views
Путь в схеме: views[]
Поле views представляет собой массив записей, описывающих различные интерфейсы системы — представления.
Описания представлений включают общие поля и специфические в зависимости от типа представления.
Общие поля для всех типов представлений
Следующая таблица описывает поля, которые присутствуют во всех записях представлений, независимо от их типа.
| Поле | Обязательность и значение по умолчанию | Описание | Тип данных |
|---|---|---|---|
|
Да |
Уникальный идентификатор интерфейса. |
View ID |
|
Нет (по умолчанию: пустая строка) |
Наименование, используемое в заголовках. Для полноэкранной карточки поддерживаются форматы: |
строка |
|
Нет (по умолчанию: пустая строка) |
Описание элемента. Не выводится в интерфейсе, но отображается на схеме домена. |
строка |
|
Да |
Тип интерфейса. Определяет, какие специфические поля будут применяться. Ознакомьтесь со списком доступных типов. |
перечисление |
Типы представлений (type)
Путь в схеме: views[].type
Поле type может принимать следующие значения:
-
entity— представление одного объекта. -
list— представление списка объектов. -
tabs_list— группа вкладок, каждая из которых содержит список объектов. -
dashboard— дашборд: группа виджетов-плиток с действиями. -
tree— представление древовидных связей. -
dashboard_tree— представление навигации по списочным представлениям.
Представление объекта (type: entity)
Представление единичного объекта включает панели и полноэкранные карточки с детальной информацией о нем, а также модальные окна создания и редактирования. Ознакомьтесь с описанием представления объекта.
Списочное представление (type: list)
Представление списка объектов содержит таблицу с возможностью фильтрами и панель действий. Ознакомьтесь с описанием списочного представления.
Списочное представление с несколькими вкладками (type: tabs_list)
Описание представления типа tabs_list дополнительно включает поля:
| Поле | Обязательность и значение по умолчанию | Описание | Тип данных |
|---|---|---|---|
|
Нет (по умолчанию: первая вкладка) |
View ID Ref вкладки, которая будет открыта по умолчанию. |
View ID Ref |
|
Да |
Массив ссылок на идентификаторы описаний интерфейсов списков. |
массив ссылок |
Дашборд (type: dashboard)
Описание представления типа dashboard дополнительно включает поля:
| Поле | Обязательность и значение по умолчанию | Описание | Тип данных |
|---|---|---|---|
|
Да |
Массив записей виджетов, используемых на дашборде. |
массив |
|
Нет |
Настройки взаимного расположения виджетов на дашборде. Ознакомьтесь с описанием поля |
объект |
Расположение компонентов (layout)
Путь в схеме: views[].layout
В поле layout задаются настройки взаимного расположения компонентов в интерфейсе. Поле имеет следующую структуру:
| Поле | Обязательность и значение по умолчанию | Описание | Тип данных |
|---|---|---|---|
|
Нет (по умолчанию: |
Тип взаимного расположения виджетов. Значение |
перечисление |
|
Нет (по умолчанию: |
Количество столбцов в сетке (при |
число |
Дерево (type: tree)
Дерево отображает древовидные связи между сущностями. Ознакомьтесь с описанием интерфейса древовидной связи.
Навигация (type: dashboard_tree)
Описание представления типа dashboard_tree дополнительно включает поля:
| Поле | Обязательное поле | Описание | Тип данных |
|---|---|---|---|
|
нет |
Настройка отображения общедоменных виджетов. Указывается идентификатор представления с |
View ID Ref |
|
да |
Настройка структуры дерева навигации. Ознакомьтесь с описанием поля |
массив |
Структуры дерева навигации (tree)
Путь в схеме: views[].tree
Поле tree является массивом элементов дерева навигации. Каждый элемент массива имеет следующую структуру:
| Поле | Обязательное поле | Описание | Тип данных |
|---|---|---|---|
|
да |
Представление, которое отображается при нажатии на элемент дерева. Указывается идентификатор представления с типом |
View ID Ref |
|
нет |
Отображаемое название элемента дерева. Если не указано, отображается название, указанное в поле |
строка |
|
нет |
Настройка автоматического построения дерева наследников. Содержит поле При нажатии на дочерний элемент открывается списочное представление этой сущности с панелью действий. Если у сущности несколько списочных представлений, выводится первое. Если у сущности нет наследников, выводится только она. |
объект |
|
нет |
Настройка вложенной структуры дерева. Имеет такую же структуру, как и поле Доступно, если не указано поле |
массив |
Пример описания дерева
tree:
- view: allCards
children:
- view: serviceVacation
- view: serviceWorkplace
- view: serviceVpn
- view: CI
label: Конфигурационная единица
autoTree:
entity: example.com/CIИконки (medias)
Путь в схеме: medias[]
Поле medias представляет собой массив записей элементов иконок. Каждый элемент массива имеет следующую структуру:
| Поле | Обязательное поле | Значение по умолчанию | Описание | Тип данных | Комментарий |
|---|---|---|---|---|---|
|
да |
Идентификатор иконки, которая будет использоваться в виджетах представлений и элементах меню. |
View ID |
||
|
нет |
Пустая строка |
Описание элемента домена. |
строка |
Не выводится в представлениях. Отображается в схеме домена |
|
да |
Тип иконки. |
перечисление |
Определяет тип медиаресурса и его возможности. В текущей реализации поддерживается один тип иконки |
|
|
да |
Идентификатор медиаресурса в библиотеке |
строка |
Была ли полезна эта страница?
