Описание классов скриптового модуля приложения "Интерактивная доска" 2.4.0 — 2.7.0

Классы ColumnParam и KanboardParams содержатся в скриптовом модуле и используются при настройке досок.

Класс ColumnParam

Класс столбца на доске.

Параметры класса:

  • title — название столбца. Отображается в верху столбца.

  • linkValues — значения, соответствующие столбцу.

    Может использоваться в параметре matchingCondition для проверки принадлежности объекта столбцу.

    Значения должны быть указаны в соответствии с форматом передачи значений атрибутов методам REST API, см. Работа с REST-сервисами в системе.

  • color — цвет столбца. Отображается в заголовке столбца.

    Значение по умолчанию — серый (#5F5F5F).

  • customStateCodes — список кодов целевых статусов, которые будут предложены для перехода, когда в текущий столбец переносят объект из другого столбца.

    Параметр учитывается, если для доски не указан параметр attributeCodeForEditing.

  • matchingCondition — способ, которым определяется принадлежность объекта на доске столбцу:

    • true — объект подходит столбцу;
    • false — объект не подходит столбцу.

    По умолчанию объект подходит столбцу, если значение объекта (параметр valueToLink) попадает в значения параметра linkValues этого столбца.

Класс KanboardParams

Класс определяет настройки доски:

  • место ее расположения (контент);
  • столбцы доски;
  • объекты, выводимые на доску;
  • настройки плашек.

Плашка доски, где 1 — id, title; 2 — description; 3 — assigneeUUID, assigneeAvatarUUID, assigneeTitle; 4 — iconUUID, iconTitle; 5 — deadline, 6 — indicatorColor, indicatorTitle

Параметры класса:

  • contentCode — код контента, в котором будет отображаться доска.

  • items — список объектов, которые выводятся на доску.

    Значение по умолчанию для карточки команды — запросы в ответственности команды, для карточки сотрудника — запросы в ответственности сотрудника. Архивные и закрытые ("closed") запросы не учитываются.

  • columnParams — список столбцов, которые выводятся на доску.

    Значение по умолчанию — список статусов класса "Запрос" (serviceCall), кроме статуса "Закрыт" (closed).

  • id — UUID объекта, карточка которого открывается при нажатии на название объекта.

  • title — название, отображаемое на плашке (ограничено 3 строками).

    Значение по умолчанию — значение атрибута с кодом title.

  • description — описание, отображаемое на плашке (ограничено 2 строками).

    Значение по умолчанию — значение атрибута с кодом shortDescr.

  • deadline — дедлайн, отображаемый на плашке.

    Значение по умолчанию — значение атрибута с кодом timeAllowanceTimer.

  • valueToLink — значение, соответствующее объекту на доске.

    Может использоваться при распределении объектов по столбцам в matchingCondition.

    Значение по умолчанию — код статуса объекта.

  • assigneeUUID — UUID ответственного за объект. Карточка ответственного открывается при нажатии на аватар на плашке.

    Значение по умолчанию — UUID ответственного за объект.

  • assigneeAvatarUUID — UUID файла, который отображается как аватар ответственного на плашке.

    Значение по умолчанию — UUID файла из атрибута с кодом image, если атрибут есть. Для ответственного сотрудника — используется аватар сотрудника, для ответственной команды — аватар генерируется автоматически.

  • assigneeTitle — текст, который отображается при наведении курсора на аватар на плашке.

    Значение по умолчанию — значение атрибута с кодом title ответственного сотрудника/команды.

  • iconUUID — UUID файла иконки, которая отображается на плашке.

    Значение по умолчанию — иконка элемента справочника из атрибута system_icon, если атрибут есть.

  • iconTitle — текст, который отображается при наведении курсора на иконку на плашке.

    Значение по умолчанию — название элемента справочника из атрибута system_icon, если атрибут есть.

  • indicatorColor — цвет индикатора, который отображается на плашке.

    Значение по умолчанию — цвет элемента справочника из атрибута priority, если атрибут есть. Если цвет индикатора не задан, он будет отображаться серым (#5F5F5F).

  • indicatorTitle — текст, который отображается при наведении курсора курсора на цветовой индикатор на плашке.

    Значение по умолчанию — название элемента справочника из атрибута priority, если атрибут есть.

  • attributeCodeForEditing — код атрибута, который будет изменен при переносе плашки между столбцами доски (код атрибута, по которому идет разбиение доски на столбцы). Например, responsibleEmployee.

    Если код не задан, то при переносе плашки между столбцами меняется статус объекта. Изменение статуса возможно, если столбцу в linkValues соответствует одно или несколько значений. Изменение другого атрибута при переносе плашки между столбцами возможно, если столбцу в linkValues соответствует только одно значение.

  • autoRefreshTimeout (с версии 2.5.1) — целочисленный интервал автоматического обновления информации на доске в минутах. Минимальное значение автообновления — одна минута.

    Значение по умолчанию — одна минута.