Методы данного класса предназначены для конфигурации списков. Используйте их для управления списками, например, из скриптов UI-действий.
Использование глобальной переменной
Внутри каждого списка можно использовать преднастроенную глобальную переменную.
Переменная | Описание |
---|
currentUiAction | Содержит объект с ID записи UI action-действия. Используйте ее при вызове контекстного меню кнопки. Одним из примеров ее использования является получение информации о UI-действии при вызове контекстного меню. Image Removed Image Added
|
Пример:
Code Block |
---|
title | currentUiAction | linenumbers | true |
---|
|
window.currentUiAction |
s_list.addErrorMessage(message)
Используйте данный метод для вывода сообщений об ошибке в правом нижнем углу окна.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
message | String | Да | Нет |
Возвращаемое значение:
Данный метод Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addErrorMessage() | linenumbers | true |
---|
|
s_list.addErrorMessage('Введите адрес электронной почты в формате: joe@example.com'); |
s_list.addInfoMessage(message, durationMilliseconds)
Используйте данный метод для отображения информационных сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в парамере durationMilliseconds в миллисекундах.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
message | String | Да | Нет |
durationMilliseconds | Number | Нет | Нет |
Возвращаемое значение:
Данный метод Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addInfoMessage() | linenumbers | true |
---|
|
s_list.addInfoMessage('Ссылка скопирована в буфер обмена', 2000); |
s_list.addSuccessMessage(message, durationMilliseconds)
Данный Используйте метод выводит , чтобы вывести сообщения об успешном действии при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором в парамере durationMilliseconds в миллисекундах.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
message | String | Да | Нет |
durationMilliseconds | Number | Нет | Нет |
Возвращаемое значение:
Данный метод Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addSuccessMessage() | linenumbers | true |
---|
|
s_list.addSuccessMessage('Запись успешно обновлена!', 3000); |
s_list.addWarningMessage(message, durationMilliseconds)
Используйте этот метод для отображения предупреждающих сообщений при работе со списками. Сообщения Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в параметре durationMilliseconds в миллисекундах.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
message | String | Да | Нет |
durationMilliseconds | Number | Нет | Нет |
Возвращаемое значение:
Данный метод Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addWarningMessage() |
---|
linenumbers | true |
---|
|
s_list.addWarningMessage('Эта запись была изменена другим пользователем', 3000); |
s_list.deleteRows(tableName, sysIds)
Данный Используйте метод предназначен для удаления одной или нескольких записей, ID которых переданы ему вторым параметром.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|
tableName | String | Да | Нет |
sysIds | Array of Strings | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|
Object | Этот Метод возвращает объект возвращает Promise, содержащий определенные данные. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | deleteRows() |
---|
linenumbers | true |
---|
|
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 of Strings | Метод возвращает массив, содержащий ID отмеченных строк. Метод возвращает пустой массив, если строки не были отмечены. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getCheckedRow() |
---|
linenumbers | true |
---|
|
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()
Данный Используйте метод возвращает , чтобы вернуть условие фильтрации отображаемых записей списка.
Возвращаемое значение:
Условие Метод возвращает условие в формате закодированного запроса. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getQuery() |
---|
linenumbers | true |
---|
|
; (() => {
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()
Данный Используйте метод возвращает , чтобы вернуть массив с названиями таблиц, списки которых отображаются в окне.
Возвращаемое значение:
stringsМассив Метод возвращает массив с названиями таблиц. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getTablesName() |
---|
linenumbers | true |
---|
|
; (() => {
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 | Да | Нет |
Возвращаемое значение:
Данный метод Метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | refresh() |
---|
linenumbers | true |
---|
|
if (confirm(translationResponse)) {
s_list.deleteRows(table, selectedRows)
.then(() => {
s_list.refresh(table);
})
} |