You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 11 Next »
Методы данного класса предназначены для конфигурации списков. Используйте их для управления списками, например, из скриптов UI-действий.
Использование глобальной переменной
Внутри каждого списка можно использовать преднастроенную глобальную переменную.
Переменная | Описание |
---|---|
currentUiAction |
Пример:
window.currentUiAction
s_list.addErrorMessage(message)
Используйте данный метод для вывода сообщений об ошибке в правом нижнем углу окна.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_list.addErrorMessage('Введите адрес электронной почты в формате: joe@example.com');
s_list.addInfoMessage(message, durationMilliseconds)
Используйте данный метод для отображения информационных сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | String | Да | Нет |
durationMilliseconds | Number | Нет | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_list.addInfoMessage('Ссылка скопирована в буфер обмена', 2000);
s_list.addSuccessMessage(message, durationMilliseconds)
Данный метод выводит сообщения об успешном действии при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | String | Да | Нет |
durationMilliseconds | Number | Нет | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_list.addSuccessMessage('Запись успешно обновлена!', 3000);
s_list.addWarningMessage(message, durationMilliseconds)
Используйте этот метод для отображения предупреждающих сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором параметре в миллисекундах.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | String | Да | Нет |
durationMilliseconds | Number | Нет | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_list.addWarningMessage('Эта запись была изменена другим пользователем', 3000);
s_list.deleteRows(tableName, sysIds)
Данный метод предназначен для удаления одной или нескольких записей, ID которых переданы ему вторым параметром.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
tableName | String | Да | Нет |
sysIds | Array | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Object | Этот объект возвращает Promise, содержащий определенные данные. |
Пример:
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.getCheckedRow(tableName)
Используйте этот метод для получения информации о строках, отмеченных в списке.
Параметр:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
tableName | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Array | Метод возвращает массив, содержащий ID отмеченных строк. Метод возвращает пустой массив, если строки не были отмечены. |
Пример:
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 | Условие в формате закодированного запроса. |
Пример:
; (() => { 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 | Массив с названиями таблиц |
Пример:
; (() => { 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 | Данный метод не возвращает значение. |
Пример:
if (confirm(translationResponse)) { s_list.deleteRows(table, selectedRows) .then(() => { s_list.refresh(table); }) }
- No labels