SDK реестра

Общие сведения

SDK реестра — это инструмент, позволяющий настраивать внешний вид реестра, сортировку, логику поиска и т. д. Он реализован в классе Terrasoft.sdk.GridPage.

Методы Terrasoft.sdk.GridPage

setPrimaryColumn()

Устанавливает первичную колонку для отображения. Настраивает отображение заголовка записи реестра.

Сигнатура метода

setPrimaryColumn(modelName, column)

Параметры

modelName — название модели.

column — название колонки.

Пример вызова

Terrasoft.sdk.GridPage.setPrimaryColumn("Case", "Subject");

setSubtitleColumns()

Устанавливает колонки, которые отображаются под заголовком. Настраивает отображение подзаголовка в виде списка колонок с разделителем.

Сигнатура метода

setSubtitleColumns(modelName, columns)

Параметры

modelName — название модели.

columns — массив колонок или конфигурационных объектов колонок.

Пример вызова

Вариант 1

Terrasoft.sdk.GridPage.setSubtitleColumns("Case", ["RegisteredOn","Number"]);

Вариант 2

Terrasoft.sdk.GridPage.setSubtitleColumns("Case", ["RegisteredOn", { name: "Number", convertFunction: function(values) { return values.Number; } }]);

setGroupColumns()

Устанавливает группу с колонками, которые отображаются вертикально. Настраивает отображение группы колонок.

Сигнатура метода

setGroupColumns(modelName, columns)

Параметры

modelName — название модели.

columns — массив колонок или конфигурационных объектов колонок.

Пример вызова

Вариант 1

Terrasoft.sdk.GridPage.setGroupColumns("Case", ["Symptoms"])

Вариант 2

Terrasoft.sdk.GridPage.setGroupColumns("Case", [
{
name: "Symptoms",
isMultiline: true,//Отображать как многострочное поле
label: "CaseGridSymptomsColumnLabel",//Имя локализованной строки
convertFunction: function(values) {
return values.Symptoms;
}
}]);

setImageColumn()

Устанавливает колонку изображения.

setOrderByColumns()

Устанавливает сортировку реестра.

setSearchColumn()

Устанавливает колонку поиска.

setSearchColumns()

Устанавливает колонки поиска.

setSearchPlaceholder()

Устанавливает текст подсказки в поле поиска.

setTitle()

Устанавливает заголовок страницы реестра.

Пример

Необходимо настроить реестр раздела [Обращения] ([Cases]) таким образом, чтобы отображался заголовок с темой обращения, подзаголовок с датой регистрации и номером, а также описание обращения в виде многострочного поля.

Для настройки реестра необходимо использовать приведенный ниже исходный код:

// Настройка первичной колонки с темой обращения.
Terrasoft.sdk.GridPage.setPrimaryColumn("Case", "Subject");
// Установка подзаголовка с датой регистрации и номером обращения.
Terrasoft.sdk.GridPage.setSubtitleColumns("Case", ["RegisteredOn","Number"]);
// Добавление многострочного поля с описанием.
Terrasoft.sdk.GridPage.setGroupColumns("Case", [
{
name: "Symptoms",
isMultiline: true
}]);

В результате реестр будет отображаться так, как показано на рис. 1.

Рис. 1. — Настроенный реестр обращений