SimpleList

Методы данного класса предназначены для конфигурации списков. Используйте их для управления списками, например, из скриптов UI-действий.

Использование глобальной переменной

---

Внутри каждого списка можно использовать преднастроенную глобальную переменную.

Переменная	Описание
currentUiAction	Содержит объект с ID записи UI-действия. Используйте ее при вызове контекстного меню кнопки. Одним из примеров ее использования является получение информации о UI-действии при вызове контекстного меню.

Пример:

currentUiAction

window.currentUiAction

s_list.addErrorMessage(message)

---

Используйте данный метод для вывода сообщений об ошибке в правом нижнем углу окна.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
message	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

addErrorMessage()

s_list.addErrorMessage('Введите адрес электронной почты в формате: joe@example.com');

s_list.addInfoMessage(message, durationMilliseconds)

---

Используйте данный метод для отображения информационных сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время в парамере durationMilliseconds в миллисекундах.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
message	String	Да	Нет
durationMilliseconds	Number	Нет	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

addInfoMessage()

s_list.addInfoMessage('Ссылка скопирована в буфер обмена', 2000);

s_list.addSuccessMessage(message, durationMilliseconds)

---

Используйте метод, чтобы вывести сообщения об успешном действии при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время в парамере durationMilliseconds в миллисекундах.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
message	String	Да	Нет
durationMilliseconds	Number	Нет	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

addSuccessMessage()

s_list.addSuccessMessage('Запись успешно обновлена!', 3000);

s_list.addWarningMessage(message, durationMilliseconds)

---

Используйте этот метод для отображения предупреждающих сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время в парамере durationMilliseconds в миллисекундах.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
message	String	Да	Нет
durationMilliseconds	Number	Нет	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

Пример:

addWarningMessage()

s_list.addWarningMessage('Эта запись была изменена другим пользователем', 3000);

s_list.deleteRows(tableName, sysIds)

---

Используйте метод для удаления одной или нескольких записей, ID которых переданы вторым параметром.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
tableName	String	Да	Нет
sysIds	Array of Strings	Да	Нет

Возвращаемое значение:

Тип	Описание
Object	Метод возвращает объект Promise, содержащий определенные данные.

deleteRows()

s_i18n.getMessage("Delete the selected record(s)?", async (translationResponse) => {
  if (confirm(translationResponse)) {
    s_list.deleteRows(table, selectedRows)
      .then(() => {
        __resolveServerResponse();
        s_list.refresh(table);
      })
  } else {
    __resolveServerResponse();
  }
});

s_list.fetchExportTable(fetchExportTable)

---

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

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
fetchExportTable	XLSX или JSON	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение

Примеры:

Для экспорта в JSON

s_list.fetchExportTable()

s_list.fetchExportTable('json');

Для экспорта в XLSX

s_list.fetchExportTable()

s_list.fetchExportTable();

или

s_list.fetchExportTable()

s_list.fetchExportTable('excel');

s_list.getCheckedRow(tableName)

---

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

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
tableName	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Array of Strings	Метод возвращает массив, содержащий ID отмеченных строк. Метод возвращает пустой массив, если строки не были отмечены.

getCheckedRow()

const table = s_list.getTablesName()[0];
const selectedRows = s_list.getCheckedRow(table);
if (!selectedRows.length) {
  s_i18n.getMessage("Нет выбранных строк.", (translationResponse) => {
    __resolveServerResponse();
    alert(translationResponse);
  });
}

s_list.getQuery()

---

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

Возвращаемое значение:

Тип	Описание
String	Метод возвращает условие в формате закодированного запроса.

getQuery()

; (() => {
  const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`);
  url.searchParams.set('condition', s_list.getQuery());
  window.open(url, '_blank');
})();

s_list.getTablesName()

---

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

Возвращаемое значение:

Тип	Описание
Array of Strings	Метод возвращает массив с названиями таблиц.

getTablesName()

; (() => {
  const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`);
  url.searchParams.set('condition', s_list.getQuery());
  window.open(url, '_blank');
})();

s_list.refresh(tableName)

---

Используйте этот метод, чтобы обновить данные в списке, заданном в параметре tableName.

Параметры:

Наименование	Тип	Обязательно	Значение по умолчанию
tableName	String	Да	Нет

Возвращаемое значение:

Тип	Описание
Void	Метод не возвращает значение.

refresh()

if (confirm(translationResponse)) {
  s_list.deleteRows(table, selectedRows)
    .then(() => {
      s_list.refresh(table);
    })
}