Методы данного класса предназначены для конфигурации списков. Например, для управления действиями UI.
Использование глобальной переменной
Внутри каждого списка можно использовать преднастроенную глобальную переменную.
Переменная | Описание |
---|
currentUiAction | Содержит объект с ID записи UI action. Используйте данную переменную при вызове контекстного меню. Одним из примеров ее использования является получение информации о действиях UI при вызове контекстного меню. 
|
Пример:
Code Block |
---|
title | currentUiAction |
---|
linenumbers | true |
---|
|
window.currentUiAction |
s_list.addErrorMessage(message)
Используйте данный метод для вывода сообщений об ошибке в правом нижнем углу.
Параметры:
Name | Type | Mandatory | Дефолтное значение |
---|
message | String | Y | N |
ВозвратВозвращаемое значение:
Type | Description |
---|
Void | Данный метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addErrorMessage |
---|
linenumbers | true |
---|
|
s_list.addErrorMessage('Please enter a valid email address using the following format: joe@example.com'); |
s_list.addInfoMessage(message, durationMilliseconds)
Используйте данный метод для отображения информационных сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|
message | String | Д | Н |
durationMilliseconds | Number | Н | Н |
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Void | Данный метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addInfoMessage |
---|
linenumbers | true |
---|
|
s_list.addInfoMessage('Link copied to clipboard', 2000); |
s_list.addSuccessMessage(message, durationMilliseconds)
Данный метод выводит сообщения об успешном действии при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|
message | String | Д | Н |
durationMilliseconds | Number | Н | Н |
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Void | Данный метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addSuccessMessage |
---|
linenumbers | true |
---|
|
s_list.addSuccessMessage('Record was successfully updated!', 3000); |
s_list.addWarningMessage(message, durationMilliseconds)
Используйте этот метод для отображения предупреждающих сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|
message | String | Д | Н |
durationMilliseconds | Number | Н | Н |
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Void | Данный метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addWarningMessage |
---|
linenumbers | true |
---|
|
s_list.addWarningMessage('This record has been modified by another user', 3000); |
deleteRows(tableName, sysIds)
Данный метод предназначен для удаления одной и более выбранных строк таблицы.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|
tableName | String | Д | Н |
sysIds | Array | Д | Н |
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Object | Этот объект возвращает промис, содержащий определенные данные. |
Пример:
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();
}
}); |
getCheckedRow(tableName)
Используйте этот метод для получения информации о строках, отмеченных в списке.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|
tableName | String | Д | Н |
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Array | Метод возвращает массив, содержащий 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("No selected rows.", (translationResponse) => {
__resolveServerResponse();
alert(translationResponse);
});
} |
getQuery()
Данный метод возвращает состояние списка.
ВозвратВозвращаемое значение:
Тип | Описание |
---|
String | Условие в формате закодированного запроса. |
Пример:
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');
})(); |
getTablesName()
Данный метод возвращает список таблиц
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Array | Список таблиц |
Пример:
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');
})(); |
refresh(tableName)
Используйте этот метод, чтобы обновить данные в списке, заданном в параметре tableName.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|
tableName | String | Д | Н |
ВозвратВозвращаемое значение:
Тип | Описание |
---|
Void | Данный метод не возвращает значение. |
Пример:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | refresh |
---|
linenumbers | true |
---|
|
if (confirm(translationResponse)) {
s_list.deleteRows(table, selectedRows)
.then(() => {
s_list.refresh(table);
})
} |