You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Методы данного класса предназначены для конфигурации списков. Например, для управления действиями UI.
Использование глобальной переменной
Внутри каждого списка можно использовать преднастроенную глобальную переменную.
Переменная | Описание |
---|---|
currentUiAction |
Пример:
window.currentUiAction
s_list.addErrorMessage(message)
Используйте данный метод для вывода сообщений об ошибке в правом нижнем углу.
Параметры:
Name | Type | Mandatory | Дефолтное значение |
---|---|---|---|
message | String | Y | N |
Возврат:
Type | Description |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
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 | Данный метод не возвращает значение. |
Пример:
s_list.addInfoMessage('Link copied to clipboard', 2000);
s_list.addSuccessMessage(message, durationMilliseconds)
Данный метод выводит сообщения об успешном действии при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
message | String | Д | Н |
durationMilliseconds | Number | Н | Н |
Возврат:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_list.addSuccessMessage('Record was successfully updated!', 3000);
s_list.addWarningMessage(message, durationMilliseconds)
Используйте этот метод для отображения предупреждающих сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
message | String | Д | Н |
durationMilliseconds | Number | Н | Н |
Возврат:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_list.addWarningMessage('This record has been modified by another user', 3000);
deleteRows(tableName, sysIds)
Данный метод предназначен для удаления одной и более выбранных строк таблицы.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
tableName | String | Д | Н |
sysIds | Array | Д | Н |
Возврат:
Тип | Описание |
---|---|
Object | Этот объект возвращает промис, содержащий определенные данные. |
Пример:
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)
Use this method to get information about the strings that are checked on the list.
Параметры:
Name | Type | Mandatory | Дефолтное значение |
---|---|---|---|
tableName | String | Y | N |
Return:
Type | Description |
---|---|
Array | An array containing IDs of the strings checked; if no strings were checked, then the method returns the empty array. |
Example:
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()
This method returns the list condition.
Return:
Type | Description |
---|---|
String | A condition formatted as an encoded query. |
Example:
; (() => { const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`); url.searchParams.set('condition', s_list.getQuery()); window.open(url, '_blank'); })();
getTablesName()
This method returns a list of the tables.
Return:
Type | Description |
---|---|
Array | The tables list. |
Example:
; (() => { 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 | Данный метод не возвращает значение. |
Пример:
if (confirm(translationResponse)) { s_list.deleteRows(table, selectedRows) .then(() => { s_list.refresh(table); }) }
- No labels