Просмотр кода страницы Платформа 3V/Справочник/Группировка

{{DISPLAYTITLE:Группировка элементов справочника (groupingOptions)}}
Разбивка на группы элементов справочника на основании от собственного или связанного атрибута

<syntaxhighlight lang="JSON" line>
  "groupingOptions": {
        "destinationAttribute": {
          "id": 2,
          "discriminator": "OwnAttributeDefinitionDto"
        },
        "dictionaryGroupingAttributes": [
          {
            "attribute": {
              "id": 21,
              "discriminator": "OwnAttributeDefinitionDto"
            },
            "DisplayAttribute": {
              "id": 2,
              "discriminator": "OwnAttributeDefinitionDto"
            },
            "groupCustomName": null
          }
        ],
        "fillOwnTransitiveForLinkedAttributes": false,
        "isGroupingNull": false,
        "nullValueGroupName": "Не задано",
        "areNullValuesLast": false,
        "areGroupingElementsLast": false
      }
</syntaxhighlight>

{| class="wikitable"
|-
! Значение !! Описание
|-
| destinationAttribute || В каком атрибуте группируемого справочника будет формироваться наименование группировочного элемента (атрибут должен быть текстовый). По умолчанию: атрибут "Наименование"
|-
| [[Платформа 3V/Справочник/Группировка|'''dictionaryGroupingAttributes''']] || Описание пути до атрибута, по которому будет производиться группировка
|-
| fillOwnTransitiveForLinkedAttributes || Флаг заполнения у группировочного элемента атрибута, который является транзитивным для группируемого справочника и собственным для справочника, по которому происходит группировка
|-
| isGroupingNull || Флаг группировки элементов с пустым атрибутом, по которому происходит группировка, под отдельный элемент (true / false). По умолчанию группировка происходит под элемент "Не задано", название указывается в nullValueGroupName 
|-
| nullValueGroupName || Наименование группировочного элемента для элементов с пустым группировочным атрибутом
|-
| areNullValuesLast || Флаг размещения последними элементов с пустым группировочным атрибутом (true / false)
|-
| areGroupingElementsLast || Флаг размещения группировочных элементов после входящих в группу элементов (true / false)
|}

== Ссылка на группировочные атрибуты (dictionaryGroupingAttributes) ==
Указываются атрибуты, по которым необходимо сгруппировать справочник. Может иметь один или больше группировочных атрибутов
<syntaxhighlight lang="JSON" line>
        "dictionaryGroupingAttributes": [
          {
            "attribute": {
              "id": 21,
              "discriminator": "OwnAttributeDefinitionDto"
            },
            "DisplayAttribute": {
              "id": 2,
              "discriminator": "OwnAttributeDefinitionDto"
            },
            "groupCustomName": null
          }
        ]
</syntaxhighlight>
{| class="wikitable"
|-
! Значение !! Описание
|-
| [[Платформа_3V/Справочник/Связь_атрибутов|'''attribute''']] || Описание пути до атрибута, по которому будет производиться группировка
|-
| DisplayAttribute|| Описание атрибута из которого будут браться наименования для группировочных элементов.
|-
| groupCustomName || Пользовательское наименование группировочных элементов

|}

== Примеры использования группировочных настроек ==

Для формирования связи между объектами строительства и инвестиционными проектами в справочнике "Объекты строительства" настроен связанный атрибут на справочник "Инвестиционный проект"

''Исходный вид справочника "Объекты строительства":''
{| class="wikitable"
|-
! Наименование объекта (id=2) !! Инвестиционный проект (id=21) !! Код объекта (id=22)
|-
| Объект 1 || ИП 1 || 01-1
|-
| Объект 2 || ИП 1 || 01-2
|-
| Объект 3 || ИП 2 || 02-3
|-
| Объект 4 || - || 00-4
|}

'''По умолчанию группировка по атрибуту "Инвестиционные проекты"'''
{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| .. Объект 4 || - || 00-4
|-
| '''ИП 1''' ||  || 
|-
| .. Объект 1 || ИП 1 || 01-1
|-
| .. Объект 2 || ИП 1 || 01-1
|-
| '''ИП 2''' ||  || 
|-
| .. Объект 3 || ИП 2 || 02-3
|}

=== Атрибут для наименования группировочного элемента (destinationAttribute) ===

Настройка позволяет группировать не в атрибуте по умолчанию "Наименование", а другом текстовом атрибуте, например "Код объекта" (id=22)
<syntaxhighlight lang="JSON" line>
        "destinationAttribute": {
          "id": 22,
          "discriminator": "OwnAttributeDefinitionDto"
        }
</syntaxhighlight>
{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| .. Объект 4 || - || 00-4
|-
|  ||  || '''ИП 1'''
|-
| .. Объект 1 || ИП 1 || 01-1
|-
| .. Объект 2 || ИП 1 || 01-1
|-
|  ||  || '''ИП 2'''
|-
| .. Объект 3 || ИП 2 || 02-3
|}

=== Атрибут, из которого будут браться наименования для группировочных элементов (DisplayAttribute) ===

Настройка позволяет отображать не только наименование инвестиционного проекта, но и другие атрибуты, например, "Код". (id=21)
<syntaxhighlight lang="JSON" line>
        "DisplayAttribute": {
          "id": 21,
          "discriminator": "OwnAttributeDefinitionDto"
        }
</syntaxhighlight>
{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| .. Объект 4 || - || 00-4
|-
| '''01''' ||  || 
|-
| .. Объект 1 || ИП 1 || 01-1
|-
| .. Объект 2 || ИП 1 || 01-1
|-
| '''02''' ||  || 
|-
| .. Объект 3 || ИП 2 || 02-3
|}

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

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

Группируем справочник "Объекты строительства" по инвестиционным проектам и необходимо, чтобы атр."Код ИП" справочника "Инвестиционные проекты" заполнился как у группируемых элементов, так и у группировочного, для этого выставляем флаг 

{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта !! Код инвест.проекта
|-
| .. Объект 4 || - || 00-4 || 
|-
| '''ИП 1''' ||  ||  || '''01''' 
|-
| .. Объект 1 || ИП 1 || 01-1 || 01
|-
| .. Объект 2 || ИП 1 || 01-2 || 01
|-
| '''ИП 2''' ||  ||  || '''02''' 
|-
| .. Объект 3 || ИП 2 || 02-3 || 02
|}

=== Флаг isGroupingNull (с учетом nullValueGroupName)===
Флаг используется при необходимости группировать элементы, которые имеют пустой группировочный атрибут под отдельный элемент с названием указанным в nullValueGroupName 

nullValueGroupName не заполнен. По умолчанию "Не задано"
{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| '''Не задано''' ||  ||
|-
| .. Объект 4 || - || 00-4
|-
| '''ИП 1''' ||  ||  
|-
| .. Объект 1 || ИП 1 || 01-1 
|-
| .. Объект 2 || ИП 1 || 01-2 
|-
| '''ИП 2''' ||   ||
|-
| .. Объект 3 || ИП 2 || 02-3
|}

nullValueGroupName: "Без ИП"
{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| '''Без ИП''' ||  ||
|-
| .. Объект 4 || - || 00-4
|-
| '''ИП 1''' ||  ||  
|-
| .. Объект 1 || ИП 1 || 01-1 
|-
| .. Объект 2 || ИП 1 || 01-2 
|-
| '''ИП 2''' ||  || 
|-
| .. Объект 3 || ИП 2 || 02-3
|}
=== Флаг areNullValuesLast ===
Флаг используется при необходимости располагать элементы с пустым группировочным атрибутом в конце таблицы

{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| '''ИП 1''' ||  ||  
|-
| .. Объект 1 || ИП 1 || 01-1 
|-
| .. Объект 2 || ИП 1 || 01-2 
|-
| '''ИП 2''' ||  ||
|-
| .. Объект 3 || ИП 2 || 02-3
|-
| Объект 4 || - || 00-4
|}
=== Флаг areGroupingElementsLast ===
Флаг используется при необходимости располагать группировочные элементы после группируемых 

{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| Объект 4 || - || 00-4
|-
| Объект 1 || ИП 1 || 01-1 
|-
| Объект 2 || ИП 1 || 01-2 
|-
| '''ИП 1''' ||  ||   
|-
| Объект 3 || ИП 2 || 02-3
|-
| '''ИП 2''' ||  ||  
|}
=== Группировка по нескольким атрибутам ===
Пример группировки по атрибуту "Инвестиционные проекты" справочника "Объекты строительства" и транзитивному атрибуту "Регион" (id=22) справочника "Инвестиционные объекты". По примеру оба инвестиционных проекта имеют в атрибуте "Регион" значение "Центральный федеральный округ".

Порядок указанных атрибутов в настройке "dictionaryGroupingAttributes" определяет порядок группировки справочника.
<syntaxhighlight lang="JSON" line>
        "dictionaryGroupingAttributes": [
           {
            "attribute": {
              "innerAttribute": {
                  "id": 22,
                  "discriminator": "OwnAttributeDefinitionDto"
              },
              "id": 21,
              "discriminator": "TransitiveAttributeDefinitionDto"
           },
            "groupCustomName": null
         },
         {
            "attribute": {
              "id": 21,
              "discriminator": "OwnAttributeDefinitionDto"
            },
            "groupCustomName": null
          }
        ]
</syntaxhighlight>

{| class="wikitable"
|-
! Номер объекта !! Инвестиционный проект !! Код объекта
|-
| .. Объект 4 || - || 00-4
|-
| '''Центральный федеральный округ''' ||  ||
|-
| '''.. ИП 1''' ||  ||
|-
| .... Объект 1 || ИП 1 || 01-1
|-
| .... Объект 2 || ИП 1 || 01-1
|-
| '''.. ИП 2''' ||  ||
|-
| .... Объект 3 || ИП 2 || 02-3
|}