Представление списка объектов

Этот раздел описывает списочное представление объектов домена.

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

Структура поля `views`

Путь в схеме: views[]

Общие поля представлений

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Уникальный идентификатор интерфейса.	View ID
`label`	Нет (по умолчанию: пустая строка)	Наименование, используемое в заголовках. Для полноэкранной карточки поддерживаются форматы: `"строка"` или `"{<attribute_id>}"`.	строка
`description`	Нет (по умолчанию: пустая строка)	Описание элемента. Не выводится в интерфейсе, но отображается на схеме домена.	строка
`type`	Да	Тип интерфейса. Устанавливается значение `list`.	перечисление

id

Да

Уникальный идентификатор интерфейса.

View ID

label

Нет (по умолчанию: пустая строка)

Наименование, используемое в заголовках. Для полноэкранной карточки поддерживаются форматы: "строка" или "{<attribute_id>}".

строка

description

Нет (по умолчанию: пустая строка)

Описание элемента. Не выводится в интерфейсе, но отображается на схеме домена.

строка

type

Да

Тип интерфейса. Устанавливается значение list.

перечисление

Поля списочного представления

Описание представления типа list дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`inherits`	Нет	Ссылка на списочное представление, от которого нужно наследовать настройки. Ознакомьтесь с описанием поля `inherits`.	View ID Ref
`source`	Да	Источник списка объектов. Ознакомьтесь с описанием поля `source`.	объект
`actionPanel`	Нет (по умолчанию: пустой массив)	Массив ссылок на виджеты действий, отображаемые на панели действий над списком. Ознакомьтесь с описанием поля `actionPanel`.	массив ссылок
`table`	Да (если не заполнено поле `inherits`)	Таблица списка объектов. Доступно для интерфейса списка объектов. Ознакомьтесь с описанием поля `table`.	объект

inherits

Нет

Ссылка на списочное представление, от которого нужно наследовать настройки.

Ознакомьтесь с описанием поля inherits.

View ID Ref

source

Да

Источник списка объектов.

Ознакомьтесь с описанием поля source.

объект

actionPanel

Нет (по умолчанию: пустой массив)

Массив ссылок на виджеты действий, отображаемые на панели действий над списком.

Ознакомьтесь с описанием поля actionPanel.

массив ссылок

table

Да (если не заполнено поле inherits)

Таблица списка объектов. Доступно для интерфейса списка объектов.

Ознакомьтесь с описанием поля table.

объект

Наследование в списочном представлении (`inherits`)

Путь в схеме: views[].inherits

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

Чтобы переопределить настройки списка, их нужно описать. Если поле не описано, его данные будет наследованы от указанного списка. В зависимости от типа поля применяется следующее поведение:

Для полей actionPanel и table.columns можно определить режим наследования с добавлением или удалением настроек.
Поля table.sortingBy, table.filter и source.joins наследуются автоматически и могут быть дополнены в текущем представлении.
Поля paging, refresh и selection наследуются автоматически и могут быть переопределены в текущем представлении.

Пример наследования в списочном представлении

Родительская сущность

id: ci.example.com
name: Конфигурационная единица
...
entities:
    - id: CI
      name: Конфигурационная единица
      ...
      # Атрибуты родительской сущности.
      attributes:
          - id: commonName
            name: Наименование
            dataType: String

          - id: description
            name: Описание
            dataType: String
          ...
...
views:
    # Списочное представление родительской сущности.
    - id: lists_ci
      type: list
      source:
         type: operational
         entity: CI
      # Панель инструментов родительской сущности.
      actionPanel:
          - widget: buttons_create
          - widget: buttons_change_type
          ...
      table:
          # Столбцы в таблице списочного представления родительской сущности.
          columns:
              - id: commonName
                attribute: commonName
              ...

Дочерняя сущность

id: db.example.com
name: База данных
...
entities:
    # Дочерняя сущность.
    - id: DB
      name: База данных
      ...
      # Атрибуты дочерней сущности.
      attributes:
          - id: dbVersion
            name: Версия
            dataType: String
          ...
      # Наследование сущности.
      inherits: db.example.com/DB
...
views:
    # Списочное представление дочерней сущности.
    - id: lists_db
      type: list
      # Наследование списочного представления.
      inherits: ci.example.com/lists_ci
      source:
         type: operational
         entity: DB
      # Панель инструментов дочерней сущности.
      actionPanel:
          - inherit:
                # Виджеты действий не наследуются.
                type: override
          - widget: buttons_create
          - widget: buttons_removeAll
          ...
      table:
          # Столбцы в таблице списочного представления дочерней сущности.         i
          columns:
              # Наследуются все столбцы представления родительской сущности, к которым добавляются собственные столбцы.
              - inherit: append
              - id: dbVersion
                attribute: dbVersion
              ...

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

Источник списка объектов (`source`)

Путь в схеме: views[].source

Поле source представляет собой параметры источника объектов для списка. Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Да (по умолчанию: `operational`)	Тип источника. Всегда устанавливается значение `operational` (база данных системы).	перечисление
`entity`	Да	Ссылка на сущность, данные объектов и связей которой отображаются в списке.	Data ID Ref или FQID
`joins`	Нет	Массив записей связей с сущностями, данные которых будут отображаться в списке. Ознакомьтесь с описанием поля joins.	массив

type

Да (по умолчанию: operational)

Тип источника. Всегда устанавливается значение operational (база данных системы).

перечисление

entity

Да

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

Data ID Ref или FQID

joins

Нет

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

Ознакомьтесь с описанием поля joins.

массив

Отображение связанных сущностей (`joins`)

Путь в схеме: views[].source.joins[]

Поле joins представляет собой массив записей связей с сущностями, данные которых будут отображаться в списке. Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Идентификатор связи.	Data ID
`linkage`	Да	Ссылка на связь с сущностью.	Data ID Ref
`side`	Нет	Сторона связи. Доступные значения: `side 1` `side 2`	перечисление
`description`	Нет (по умолчанию: пустая строка)	Описание связи.	строка

id

Да

Идентификатор связи.

Data ID

linkage

Да

Ссылка на связь с сущностью.

Data ID Ref

side

Нет

Сторона связи. Доступные значения:

side 1
side 2

перечисление

description

Нет (по умолчанию: пустая строка)

Описание связи.

строка

Панель действий в списочном представлении (`actionPanel`)

Путь в схеме: views[].actionPanel[]

Блок actionPanel является массивом, который содержит:

Поле inherit с настройками наследования действий. Доступно, если заполнено поле inherits.
Ссылки на виджеты действий, отображаемые на панели действий над списком, в формате widget: <View ID Ref>.

Настройки наследования действий в списочном представлении (`inherit`)

Путь в схеме: views[].actionPanel[].inherit

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Нет (по умолчанию: `append`)	Тип наследования. Доступные значения: `append` — наследовать все действия и добавить действия, описанные в массиве `actionPanel`. `override` — не наследовать действия. Необходимо описать действия в массиве. `except` — наследовать все действия, кроме тех, ссылки на которые приведены в поле `except`.	перечисление
`except`	Да (при `type: except`)	Массив ссылок на виджеты действий, которые не нужно наследовать, в формате `widget: <View ID Ref>`.	массив

type

Нет (по умолчанию: append)

Тип наследования. Доступные значения:

append — наследовать все действия и добавить действия, описанные в массиве actionPanel.
override — не наследовать действия. Необходимо описать действия в массиве.
except — наследовать все действия, кроме тех, ссылки на которые приведены в поле except.

перечисление

except

Да (при type: except)

Массив ссылок на виджеты действий, которые не нужно наследовать, в формате widget: <View ID Ref>.

массив

Табличное отображение списка объектов (`table`)

Путь в схеме: views[].table

Блок table содержит настройки табличного отображения сведений о списке объектов.

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

Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`columns`	да		Массив записей с описанием столбцов таблицы.	массив столбцов таблицы	Ознакомьтесь с описанием поля `columns`.
`filter`	нет		Настройки фильтрации столбцов.	объект	Ознакомьтесь с описанием поля `filter`.
`sortingBy`	нет		Ссылки на правила сортировки атрибутов сущности.	объект	Ознакомьтесь с описанием поля `sortingBy`.
`paging`	нет		Пагинация данных.	объект	Ознакомьтесь с описанием поля `paging`.
`refresh`	нет		Обновление данных.	объект	Ознакомьтесь с описанием поля `refresh`.
`selection`	нет	`false`	Переключатель возможности выбора строки.	логическое
`actions`	нет	Пустой массив	Действие при нажатии на строку таблицы.	массив действий на события таблицы	Ознакомьтесь с описанием поля `actions`.
`empty`	нет		Информация, отображаемая в таблице, если данные отсутствуют. Содержит поле `message` со строкой сообщения.	объект

columns

да

Массив записей с описанием столбцов таблицы.

массив столбцов таблицы

Ознакомьтесь с описанием поля columns.

filter

нет

Настройки фильтрации столбцов.

объект

Ознакомьтесь с описанием поля filter.

sortingBy

нет

Ссылки на правила сортировки атрибутов сущности.

объект

Ознакомьтесь с описанием поля sortingBy.

paging

нет

Пагинация данных.

объект

Ознакомьтесь с описанием поля paging.

refresh

нет

Обновление данных.

объект

Ознакомьтесь с описанием поля refresh.

selection

нет

false

Переключатель возможности выбора строки.

логическое

actions

нет

Пустой массив

Действие при нажатии на строку таблицы.

массив действий на события таблицы

Ознакомьтесь с описанием поля actions.

empty

нет

Информация, отображаемая в таблице, если данные отсутствуют. Содержит поле message со строкой сообщения.

объект

Структура `columns` (в таблице списка объектов)

Путь в схеме: views[].table.columns[]

Блок columns является массивом и содержит:

Поле inherit с настройками наследования столбцов. Доступно, если заполнено поле inherits.

Поле automatic с настройками автоматического сбора атрибутов.

Настройки inherit имеют приоритет перед automatic. Сначала происходит наследование столбцов, а затем автоматический сбор.

Записи столбцов таблицы.

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

Пример определения порядка столбцов

table:
    columns:
        - id: commonName
          attribute: commonName
        - automatic:
             type: all
        - id: create
          attribute: createdAt

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

Настройки наследования столбцов таблицы (`inherit`)

Путь в схеме: views[].table.columns[].inherit

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Нет (по умолчанию: `append`)	Тип наследования. Доступные значения: `append` — наследовать все столбцы и добавить столбцы, описанные в массиве `columns`. `override` — не наследовать столбцы таблицы. Необходимо описать столбец в массиве. `except` — наследовать все столбцы, кроме тех, ссылки на которые приведены в поле `except`.	перечисление
`except`	Да (при `type: except`)	Массив ссылок на атрибуты, которые не нужно наследовать, в формате `attribute: <Data ID Ref>`.	массив

type

Нет (по умолчанию: append)

Тип наследования. Доступные значения:

append — наследовать все столбцы и добавить столбцы, описанные в массиве columns.
override — не наследовать столбцы таблицы. Необходимо описать столбец в массиве.
except — наследовать все столбцы, кроме тех, ссылки на которые приведены в поле except.

перечисление

except

Да (при type: except)

Массив ссылок на атрибуты, которые не нужно наследовать, в формате attribute: <Data ID Ref>.

массив

Настройки автоматического сбора атрибутов (`automatic`)

Путь в схеме: views[].table.columns[].automatic

Система может автоматически формировать табличное представление на основе описанных атрибутов сущности.

При автоматизации используются следующие настройки:

label: используется значение label атрибута;
layout: вычисляется автоматически.

Для сортировки можно определить столбцы, по которым она производится.

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`type`	Да	Тип автоматизации. Доступные значения: only — вывод только тех атрибутов сущности, ссылки на которые приведены в поле `only`; all — вывод всех атрибутов текущей сущности и всех родительских сущностей; except — вывод всех атрибутов текущей сущности и всех родительских сущностей, кроме тех, ссылки на которые приведены в поле `except`.	перечисление
`only`	Да (при `type: only`)	Массив ссылок на атрибуты, которые нужно вывести при автоматизации, в формате `attribute: <Data ID Ref>`. Поддерживаются атрибуты всех типов, кроме `Table`.	массив
`except`	Да (при `type: except`)	Массив ссылок на атрибуты, которые не нужно выводить при автоматизации, в формате `attribute: <Data ID Ref>`. Поддерживаются атрибуты всех типов, кроме `Table`.	массив
`layout`	Нет	Настройки размера и видимости столбцов при автоматизации. Ознакомьтесь с описанием поля `layout`.	объект

type

Да

Тип автоматизации. Доступные значения:

only — вывод только тех атрибутов сущности, ссылки на которые приведены в поле only;
all — вывод всех атрибутов текущей сущности и всех родительских сущностей;
except — вывод всех атрибутов текущей сущности и всех родительских сущностей, кроме тех, ссылки на которые приведены в поле except.

перечисление

only

Да (при type: only)

Массив ссылок на атрибуты, которые нужно вывести при автоматизации, в формате attribute: <Data ID Ref>.

Поддерживаются атрибуты всех типов, кроме Table.

массив

except

Да (при type: except)

Массив ссылок на атрибуты, которые не нужно выводить при автоматизации, в формате attribute: <Data ID Ref>.

Поддерживаются атрибуты всех типов, кроме Table.

массив

layout

Нет

Настройки размера и видимости столбцов при автоматизации.

Ознакомьтесь с описанием поля layout.

объект

Пример наследования и автоматического сбора столбцов

table:
    columns:
        - inherit:
             type: append
        - automatic:
             type: all
    filter:
        attributes:
             type: all
    sortingBy:
        columns:
             - automatic:
                   type: all

В данном примере в таблице наследуется список столбцов от представления, указанного в поле inherits, затем к ним добавляются столбцы, перечисленные в описании сущности.

Фильтрация и сортировка происходят по всем столбцам таблицы.

Описание столбца таблицы

Путь в схеме: views[].table.columns[]

Записи столбцов переопределяют и дополняют настройки автоматического сбора, определенные в поле automatic.

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

в поле attribute: значение id;
в поле control: ссылка на дерево.

Поле с путем в дереве не поддерживает сортировку и фильтрацию.

Запись столбца включает следующие поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`id`	да	View ID	Идентификатор столбца таблицы.
`attribute`	да	Data ID Ref или FQID	Атрибут, значения которого отображаются в столбце. Допустимые значения: обычные атрибуты; системные атрибуты; атрибуты-таблицы. Конкретные атрибуты атрибута-таблицы указываются в поле `use`. атрибуты связанной сущности, указанной в поле `join`; `label` — лейбл связанной сущности; `id` — идентификатор, для указания пути к объекту.
`label`	нет	строка	Наименование столбца. Если значение не задано, в качестве наименования используется `id` столбца. Ознакомьтесь с описанием поля `label`.
`layout`	нет	объект	Настройки размера и видимости столбца. Ознакомьтесь с описанием поля `layout`.
`control`	нет	объект	Тип редактора в столбце. В этом поле можно изменить используемый по умолчанию тип редактора на другой допустимый тип. Ознакомьтесь с описанием поля `control`.
`join`	да (для атрибутов связанных сущностей)	Data ID Ref	Ссылка на идентификатор связи или соединения с транзитивной связью с сущностью, атрибут которой будет отображаться. Связь должна быть предварительно задана в поле `joins` в описании интерфейса списка объектов.
`counterColorPattern`	нет	Data ID Ref	Ссылка на правило цветовой схемы счетчика. Доступна, если атрибутом является счетчик.
`use`	да (для атрибутов таблиц)	массив	Ссылки на атрибуты атрибута-таблицы в формате `attribute: <Data ID Ref>`.

id

да

View ID

Идентификатор столбца таблицы.

attribute

да

Data ID Ref или FQID

Атрибут, значения которого отображаются в столбце. Допустимые значения:

обычные атрибуты;
системные атрибуты;
атрибуты-таблицы. Конкретные атрибуты атрибута-таблицы указываются в поле use.
атрибуты связанной сущности, указанной в поле join;
label — лейбл связанной сущности;
id — идентификатор, для указания пути к объекту.

label

нет

строка

Наименование столбца. Если значение не задано, в качестве наименования используется id столбца.

Ознакомьтесь с описанием поля label.

layout

нет

объект

Настройки размера и видимости столбца. Ознакомьтесь с описанием поля layout.

control

нет

объект

Тип редактора в столбце.

В этом поле можно изменить используемый по умолчанию тип редактора на другой допустимый тип. Ознакомьтесь с описанием поля control.

join

да (для атрибутов связанных сущностей)

Data ID Ref

Ссылка на идентификатор связи или соединения с транзитивной связью с сущностью, атрибут которой будет отображаться.

Связь должна быть предварительно задана в поле joins в описании интерфейса списка объектов.

counterColorPattern

нет

Data ID Ref

Ссылка на правило цветовой схемы счетчика. Доступна, если атрибутом является счетчик.

use

да (для атрибутов таблиц)

массив

Ссылки на атрибуты атрибута-таблицы в формате attribute: <Data ID Ref>.

Редактор в столбце списка объектов (`control`)

Путь в схеме: views[].table.columns[].control

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`type`	да	перечисление	Возможные значения: Допустимые типы для разных контекстов, представленные в таблице. Значение `tree_path` для пути объекта в дереве.
`tree`	да (при `type: tree_path`)	Data ID Ref или FQID	Ссылка на идентификатор дерева.
`trueText`	да (при type: `bool_text`)	строка	Отображаемая строка для значения `True`.
`falseText`	да (при type: `bool_text`)	строка	Отображаемая строка для значения `False`.

type

да

перечисление

Возможные значения:

Допустимые типы для разных контекстов, представленные в таблице.
Значение tree_path для пути объекта в дереве.

tree

да (при type: tree_path)

Data ID Ref или FQID

Ссылка на идентификатор дерева.

trueText

да (при type: bool_text)

строка

Отображаемая строка для значения True.

falseText

да (при type: bool_text)

строка

Отображаемая строка для значения False.

Пример описания столбцов в таблице

trees:
  - id: DevicesTree

views:
  - id: deviceList
    type: list
    ...
    source:
      type: operational
      entity: Device
      joins:
          # Массив связей с сущностями, данные которых отображаются в списке.
        - id: linkedOffice
          linkage: deviceToOffices
          ...
    table:
      columns:
        # Идентификатор столбца.
        - id: UUID
          # Атрибут столбца.
          attribute: UUID_field
        ...
        - id: Description
          attribute: description_field
          control:
            # Переопределенный тип редактора -- text_area вместо text по умолчанию.
            type: text_area
        - id: Table
          attribute: table_field
          use:
            # Массив атрибутов атрибута-таблицы.
            - attribute: WorkflowInTable
              control:
                type: level
            - id: Boolean
              attribute: fieldBoolean
              control:
                type: bool_text
                trueText: "value is true"
                falseText: "value is false!"
        - id: officeAddress
          # Ссылка на идентификатор связи с сущностью.
          join: linkedOffice
          # Атрибут связанной сущности.
          attribute: address

        # Столбцы системных атрибутов.
        - id: entityId
          attribute: entityId
          label: Идентификатор сущности

        - id: entityName
          attribute: entityName

        # Столбец с отображением пути.
        - id: treePath
          attribute: id
          control:
            type: tree_path
            # Ссылка на дерево.
            tree: domain.com/DevicesTree

Настройки размера и видимости столбца (`layout`)

Путь в схеме:

views[].table.columns[].layout
views[].table.columns[].automatic.layout

Поле layout содержит настройки размера и видимости. Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`visible`	нет	`true`	Видимость столбца.	строка	В этом поле доступны следующие значения: `true` — столбец отображается (значение по умолчанию). `false` — столбец скрыт.
`width`	нет		Ширина столбца в пикселях.	объект	Ознакомьтесь с описанием поля `width`.

visible

нет

true

Видимость столбца.

строка

В этом поле доступны следующие значения:

true — столбец отображается (значение по умолчанию).
false — столбец скрыт.

width

нет

Ширина столбца в пикселях.

объект

Ознакомьтесь с описанием поля width.

Схема использования столбца

table:
  columns:
    # Идентификатор столбца.
    - id:
      # Атрибут столбца.
      attribute:
      # Тип данных в столбце.
      type
      # Массив настроек столбца.
      layout:
        # Параметр видимости столбца.
        visible:
        # Ширина столбца (по умолчанию, минимальная, максимальная).
        width:
          default:
          min:
          max:

Настройки ширины столбца (`width`)

Путь в схеме: views[].table.columns[].layout.width

Поле width содержит настройки ширины столбца. Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`default`	да	Ширина столбца по умолчанию, в пикселях.	целое положительное число
`min`	да	Минимальная ширина столбца в пикселях.	целое положительное число
`max`	да	Максимальная ширина столбца в пикселях.	целое положительное число

default

да

Ширина столбца по умолчанию, в пикселях.

целое положительное число

min

да

Минимальная ширина столбца в пикселях.

целое положительное число

max

да

Максимальная ширина столбца в пикселях.

целое положительное число

Фильтрация списка (`filter`)

Путь в схеме: views[].table.filter

Данные, по которым осуществляется фильтрация, должны быть описаны в настройках фильтрации. Фильтрация по этим данным в системе доступна независимо от того, отображаются ли они в интерфейсе списка объектов — таблице.

Фильтровать данные можно:

по атрибутам сущности;
по лейблу и атрибутам связанного объекта, в том числе из других доменов.
по атрибутам связи, в том числе из других доменов.

Фильтрация по атрибутам связанного объекта невозможна, если связь установлена через атрибут типа Reference.

Для ссылки на атрибут в настройках фильтрации используйте значение поля id в описании атрибута сущности.

Поле filter содержит настройки фильтрации столбцов таблицы. Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`attributes`	нет		Массив ссылок на атрибуты сущности, по которым производится фильтрация.		Ознакомьтесь с описанием поля `attributes`.
`linkages`	нет		Массив ссылок на связи сущности, по которым производится фильтрация.		Ознакомьтесь с описанием поля `linkages`.

attributes

нет

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

Ознакомьтесь с описанием поля attributes.

linkages

нет

Массив ссылок на связи сущности, по которым производится фильтрация.

Ознакомьтесь с описанием поля linkages.

Схема фильтрации по отдельным атрибутам и связям

table:
  # Поле фильтрации.
  filter:
    # Тип фильтрации по отдельным атрибутам, перечисленным в поле use.
    attributes:
      type: specific
      use:
        - attribute: <attribute_1>
        - attribute: <attribute_2>
        ...
        # Фильтрация по атрибутам атрибута-таблицы.
        - attribute: <table_attribute>
          use:
            - attribute: <table_attribute_1>
            - attribute: <table_attribute_2>
            ...
    # Тип фильтрации по отдельным связям, перечисленным в поле use.
    linkages:
      type: specific
      use:
          # Ссылка на связь с сущностью.
          - linkage: <entity_1>
            link_attributes:
              # Атрибуты связи, по которым будет производиться фильтрация.
              - <link_attribute_1>
              - <link_attribute_2>
              ...
            linkedEntity:
              # Ссылки на атрибуты связанной сущности, по которым будет производиться фильтрация.
              - attribute: <attribute_3>
              - attribute: <attribute_4>
              ...
          - linkage: <entity_2>
          ...

Атрибуты для фильтрации списка (`attributes`)

Путь в схеме: views[].table.filter.attributes

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

Поле Обязательное поля Описание Тип данных

Поле	Обязательное поля	Описание	Тип данных
`type`	да	тип фильтрации. Доступные значения: `specific` — фильтрация осуществляется по атрибутам сущности, ссылки на которые приведены в поле `use`. `all` — фильтрация осуществляется по всем атрибутам. При использовании этого типа ссылки на атрибуты в поле `use` приводить не нужно.	перечисление
`use`	да (при `type: specific`)	Массив ссылок на атрибуты, по которым производится фильтрация. Ознакомьтесь с описанием поля `use`.	массив

type

да

тип фильтрации. Доступные значения:

specific — фильтрация осуществляется по атрибутам сущности, ссылки на которые приведены в поле use.
all — фильтрация осуществляется по всем атрибутам. При использовании этого типа ссылки на атрибуты в поле use приводить не нужно.

перечисление

use

да (при type: specific)

Массив ссылок на атрибуты, по которым производится фильтрация.

Ознакомьтесь с описанием поля use.

массив

Перечень атрибутов для фильтрации (`use`)

Путь в схеме: views[].table.filter.attributes.use[]

Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`attribute`	да	Data ID Ref	Ссылка на атрибут.
`use`	да (для атрибутов типа Таблица)	массив	Атрибуты атрибута-таблицы. Содержит массив полей `attribute` со ссылками на атрибуты.

attribute

да

Data ID Ref

Ссылка на атрибут.

use

да (для атрибутов типа Таблица)

массив

Атрибуты атрибута-таблицы. Содержит массив полей attribute со ссылками на атрибуты.

Связи для фильтрации (`linkages`)

Путь в схеме: views[].table.linkages

Поле linkages используется:

для задания ссылок на связи сущности, по которым производится фильтрация;
для задания атрибутов связанных сущностей, по которым производится фильтрация.

Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`type`	да (при ссылках на связи)		Тип фильтрации.		Заполняется при задании ссылок на связи сущности. Можно указать следующие типы фильтрации: `specific` — фильтрация осуществляется по связям, ссылки на которые приведены в поле `use`. `all` — фильтрация осуществляется по всем связям. При использовании этого типа ссылки на связи в поле `use` приводить не нужно.
`use`	да (при ссылках на связи)		Массив ссылок на связи, по которым производится фильтрация.		Задается, если в поле `type` указано значение `specific`. В этом поле перечисляются связи, по которым осуществляется фильтрация в таблице. Ознакомьтесь с описанием поля `use` и схемой.

type

да (при ссылках на связи)

Тип фильтрации.

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

specific — фильтрация осуществляется по связям, ссылки на которые приведены в поле use.
all — фильтрация осуществляется по всем связям. При использовании этого типа ссылки на связи в поле use приводить не нужно.

use

да (при ссылках на связи)

Массив ссылок на связи, по которым производится фильтрация.

Задается, если в поле type указано значение specific.

В этом поле перечисляются связи, по которым осуществляется фильтрация в таблице. Ознакомьтесь с описанием поля use и схемой.

Перечень связей для фильтрации (`use`)

Путь в схеме: views[].table.filter.linkages.use[]

Каждый элемент массива имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`linkage`	да	Data ID Ref или FQID	Ссылка на связь с другой сущностью. Заполняется при задании ссылок на атрибуты связи или связанной сущности.
`join`	да	Data ID Ref	Ссылка на соединение с транзитивной связью. Заполняется при задании атрибута транзитивной связи или связанной сущности.
`link_attributes`	нет	массив	Массив атрибутов связи, по которым нужна фильтрация, в формате `attribute: <Data ID Ref>`.
`linkedEntity`	да	массив	Массив атрибутов связанной сущности, по которым будет доступна фильтрация, в формате `attribute: <Data ID Ref или FQID>`.

linkage

да

Data ID Ref или FQID

Ссылка на связь с другой сущностью. Заполняется при задании ссылок на атрибуты связи или связанной сущности.

join

да

Data ID Ref

Ссылка на соединение с транзитивной связью. Заполняется при задании атрибута транзитивной связи или связанной сущности.

link_attributes

нет

массив

Массив атрибутов связи, по которым нужна фильтрация, в формате attribute: <Data ID Ref>.

linkedEntity

да

массив

Массив атрибутов связанной сущности, по которым будет доступна фильтрация, в формате attribute: <Data ID Ref или FQID>.

Сортировка списка (`sortingBy`)

Путь в схеме: views[].table.sortingBy

Поле sortingBy содержит описание сортировки в столбцах таблицы. Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`columns`	да	массив	Массив записей столбцов, для которых возможна сортировка в таблице. Ознакомьтесь с описанием поля `columns`.
`defaults`	нет	объект	Столбец и направление для сортировки по умолчанию. Ознакомьтесь с описанием поля `defaults`.

columns

да

массив

Массив записей столбцов, для которых возможна сортировка в таблице. Ознакомьтесь с описанием поля columns.

defaults

нет

объект

Столбец и направление для сортировки по умолчанию. Ознакомьтесь с описанием поля defaults.

Привязка правил сортировки к столбцам таблицы (`columns`)

Путь в схеме: views[].table.sortingBy.columns[]

Блок columns является массивом и содержит:

Поле automatic с настройками сортировки для автоматического сбора атрибутов.
Записи столбцов таблицы.

Сортировка автоматически собранных атрибутов (`automatic`)

Путь в схеме: views[].table.sortingBy.columns[].automatic

При автоматическом сборе атрибутов используются правила сортировки, определенные для атрибутов в схеме домена. Если правило для атрибута не определено, используется автоматическая сортировка по убыванию для всех типов, кроме Table и Array.

Поле имеет следующую структуру:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`type`	Да	Тип автоматической сортировки. Доступные значения: only — сортировка только по тем атрибутов сущности, ссылки на которые приведены в поле `only`; all — сортировка по всем атрибутам сущности. except — сортировка по всем атрибутам сущности, кроме тех, ссылки на которые приведены в поле `except`.	перечисление
`only`	Да (при `type: only`)	Массив ссылок на атрибуты, по которым нужно сортировать таблицу, в формате `attribute: <Data ID Ref>`. Поддерживаются атрибуты всех типов, кроме `Table` и `Array`.	массив
`except`	Да (при `type: except`)	Массив ссылок на атрибуты, по которым не нужно сортировать таблицу, в формате `attribute: <Data ID Ref>`.	массив

type

Да

Тип автоматической сортировки. Доступные значения:

only — сортировка только по тем атрибутов сущности, ссылки на которые приведены в поле only;
all — сортировка по всем атрибутам сущности.
except — сортировка по всем атрибутам сущности, кроме тех, ссылки на которые приведены в поле except.

перечисление

only

Да (при type: only)

Массив ссылок на атрибуты, по которым нужно сортировать таблицу, в формате attribute: <Data ID Ref>.

Поддерживаются атрибуты всех типов, кроме Table и Array.

массив

except

Да (при type: except)

Массив ссылок на атрибуты, по которым не нужно сортировать таблицу, в формате attribute: <Data ID Ref>.

массив

Привязка столбца к правилу сортировки

Путь в схеме: views[].table.sortingBy.columns[]

Поле имеет следующую структуру:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`column`	Да	Столбец, по которому выполняется сортировка	View ID Ref
`sorting`	Да	Правило, в соответствии с которым выполняется сортировка.	Data ID Ref

column

Да

Столбец, по которому выполняется сортировка

View ID Ref

sorting

Да

Правило, в соответствии с которым выполняется сортировка.

Data ID Ref

Сортировка по умолчанию (`defaults`)

Путь в схеме: views[].table.sortingBy.defaults

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`column`	да	View ID Ref	Ссылка на столбец для сортировки по умолчанию.
`direction`	да	перечисление	Направление сортировки: * `asc` — сортировка по возрастанию; * `desc` — сортировка по убыванию.

column

да

View ID Ref

Ссылка на столбец для сортировки по умолчанию.

direction

да

перечисление

Направление сортировки: * asc — сортировка по возрастанию; * desc — сортировка по убыванию.

Количество записей (`paging`)

Путь в схеме: views[].table.paging

Поле paging содержит настройки количества записей, показываемых в таблице. Поле имеет следующую структуру:

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`sizes`	да		Количество записей, показываемых в таблице.	массив целых положительных чисел	В этом поле указываются варианты количества записей, доступные для выбора в настройке. Например, `[10, 50, 100]`.
`defaultSize`	да		Количество записей, показываемых по умолчанию.	целое положительное число

sizes

да

Количество записей, показываемых в таблице.

массив целых положительных чисел

В этом поле указываются варианты количества записей, доступные для выбора в настройке. Например, [10, 50, 100].

defaultSize

да

Количество записей, показываемых по умолчанию.

целое положительное число

Обновление списка (`refresh`)

Путь в схеме: views[].table.refresh

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

Поле Обязательное поле Значение по умолчанию Описание Тип данных Комментарий

Поле	Обязательное поле	Значение по умолчанию	Описание	Тип данных	Комментарий
`mode`	да		Режимы обновления.	перечисление	В этом поле указываются режимы обновления записей: `manual` — обновление производится вручную; `auto` — обновление производится автоматически с заданным интервалом; `all` — обновление производится вручную и автоматически.
`defaults`	да		Настройки автообновления.	объект	Поле доступно только для настроек фильтров таблиц с типами: `all`; `auto`. Ознакомьтесь с описанием поля `defaults`.

mode

да

Режимы обновления.

перечисление

В этом поле указываются режимы обновления записей:

manual — обновление производится вручную;
auto — обновление производится автоматически с заданным интервалом;
all — обновление производится вручную и автоматически.

defaults

да

Настройки автообновления.

объект

Поле доступно только для настроек фильтров таблиц с типами:

all;
auto.

Ознакомьтесь с описанием поля defaults.

Автообновление (`defaults`)

Путь в схеме: views[].table.refresh.defaults

Поле defaults содержит настройки автообновления записей, показываемых в таблице. Используется, если в поле mode установлено значение auto или all. Поле имеет следующую структуру:

Поле Описание Тип данных Комментарий

Поле	Описание	Тип данных	Комментарий
`enabled`	Включение и выключение автообновления.	булево
`unit`	Единица измерения интервала автообновления.	перечисление	Доступные значения: `second` — секунды; `minute` — минуты; `hour` — часы.
`interval`	Количество единиц измерения интервала автообновления.	целое положительное число

enabled

Включение и выключение автообновления.

булево

unit

Единица измерения интервала автообновления.

перечисление

Доступные значения:

second — секунды;
minute — минуты;
hour — часы.

interval

Количество единиц измерения интервала автообновления.

целое положительное число

Действия в таблице (`actions`)

Путь в схеме: views[].table.actions[]

Поле actions содержит настройки действий в таблице. Каждый элемент массива имеет следующую структуру:

Поле Описание Тип данных Комментарий

Поле	Описание	Тип данных	Комментарий
`type`	Тип действия.	строка	Доступные значения: `row_click` — действие при нажатии на строку. `row_double_click` — действие при двойном нажатии на строку. `row_context_menu` — отображение контекстного меню при нажатии правой кнопкой мыши на строку.
`action`	Ссылка на идентификатор действия.	строка	Доступно только для действия типа `row_click`.
`items`	Массив ссылок на идентификаторы действий в контекстном меню.	строка	Максимальное количество записей в массиве: 7. Доступно только для действия типа `row_context_menu`. Ознакомьтесь с описанием поля `items`.

type

Тип действия.

строка

Доступные значения:

row_click — действие при нажатии на строку.
row_double_click — действие при двойном нажатии на строку.
row_context_menu — отображение контекстного меню при нажатии правой кнопкой мыши на строку.

action

Ссылка на идентификатор действия.

строка

Доступно только для действия типа row_click.

items

Массив ссылок на идентификаторы действий в контекстном меню.

строка

Максимальное количество записей в массиве: 7.

Доступно только для действия типа row_context_menu.

Ознакомьтесь с описанием поля items.

Действия в контекстном меню (`items`)

Путь в схеме: views[].table.actions[].items[]

Поле items содержит массив ссылок на идентификаторы действий в контекстном меню. Каждый элемент массива имеет следующую структуру:

Поле Описание Тип данных Комментарий

Поле	Описание	Тип данных	Комментарий
`action`	Действие.	Ссылка на идентификатор действия
`label`	Название действия, отображаемое в контекстном меню.	строка	Если значение поля не задано, отображается значение поля `name` в описании действия.
`icon`	Иконка действия в контекстном меню.	Ссылка на идентификатор иконки

action

Действие.

Ссылка на идентификатор действия

label

Название действия, отображаемое в контекстном меню.

строка

Если значение поля не задано, отображается значение поля name в описании действия.

icon

Иконка действия в контекстном меню.

Ссылка на идентификатор иконки

Была ли полезна эта страница?

Обратная связь

Представление списка объектов

Структура поля views

Общие поля представлений

Поля списочного представления

Наследование в списочном представлении (inherits)

Источник списка объектов (source)

Отображение связанных сущностей (joins)

Панель действий в списочном представлении (actionPanel)

Настройки наследования действий в списочном представлении (inherit)

Табличное отображение списка объектов (table)

Структура columns (в таблице списка объектов)

Настройки наследования столбцов таблицы (inherit)

Настройки автоматического сбора атрибутов (automatic)

Описание столбца таблицы

Редактор в столбце списка объектов (control)

Настройки размера и видимости столбца (layout)

Настройки ширины столбца (width)

Фильтрация списка (filter)

Атрибуты для фильтрации списка (attributes)

Перечень атрибутов для фильтрации (use)

Связи для фильтрации (linkages)

Перечень связей для фильтрации (use)

Сортировка списка (sortingBy)

Привязка правил сортировки к столбцам таблицы (columns)

Сортировка автоматически собранных атрибутов (automatic)

Привязка столбца к правилу сортировки

Сортировка по умолчанию (defaults)

Количество записей (paging)

Обновление списка (refresh)

Автообновление (defaults)

Действия в таблице (actions)

Действия в контекстном меню (items)

Структура поля `views`

Наследование в списочном представлении (`inherits`)

Источник списка объектов (`source`)

Отображение связанных сущностей (`joins`)

Панель действий в списочном представлении (`actionPanel`)

Настройки наследования действий в списочном представлении (`inherit`)

Табличное отображение списка объектов (`table`)

Структура `columns` (в таблице списка объектов)

Настройки наследования столбцов таблицы (`inherit`)

Настройки автоматического сбора атрибутов (`automatic`)

Редактор в столбце списка объектов (`control`)

Настройки размера и видимости столбца (`layout`)

Настройки ширины столбца (`width`)

Фильтрация списка (`filter`)

Атрибуты для фильтрации списка (`attributes`)

Перечень атрибутов для фильтрации (`use`)

Связи для фильтрации (`linkages`)

Перечень связей для фильтрации (`use`)

Сортировка списка (`sortingBy`)

Привязка правил сортировки к столбцам таблицы (`columns`)

Сортировка автоматически собранных атрибутов (`automatic`)

Сортировка по умолчанию (`defaults`)

Количество записей (`paging`)

Обновление списка (`refresh`)

Автообновление (`defaults`)

Действия в таблице (`actions`)

Действия в контекстном меню (`items`)