You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

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

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


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

Переменная

Описание

currentUiAction

Содержит объект с ID записи UI action. Используйте данную переменную при вызове контекстного меню.

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

Пример:

currentUiAction
window.currentUiAction


s_list.addErrorMessage(message)


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


Параметры:

NameTypeMandatoryДефолтное значение
messageStringYN


Возврат:

TypeDescription
VoidДанный метод не возвращает значение.


Пример:

addErrorMessage
s_list.addErrorMessage('Please enter a valid email address using the following format: joe@example.com');


s_list.addInfoMessage(message, durationMilliseconds)


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


Параметры:

НазваниеТипОбязательныйДефолтное значение
messageStringДН
durationMillisecondsNumberНН


Возврат:

ТипОписание
VoidДанный метод не возвращает значение.

Пример:

addInfoMessage
s_list.addInfoMessage('Link copied to clipboard', 2000);

s_list.addSuccessMessage(message, durationMilliseconds)


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


Параметры:

НазваниеТипОбязательныйДефолтное значение
messageStringДН
durationMillisecondsNumberНН


Возврат:

ТипОписание
VoidДанный метод не возвращает значение.


Пример:

addSuccessMessage
s_list.addSuccessMessage('Record was successfully updated!', 3000);


s_list.addWarningMessage(message, durationMilliseconds)


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


Параметры:

НазваниеТипОбязательныйДефолтное значение
messageStringДН
durationMillisecondsNumberНН


Возврат:

ТипОписание
VoidДанный метод не возвращает значение.


Пример:

addWarningMessage
s_list.addWarningMessage('This record has been modified by another user', 3000);


deleteRows(tableName, sysIds)


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


Параметры:

НазваниеТипОбязательныйДефолтное значение
tableNameStringДН
sysIdsArrayДН


Возврат:

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


Пример:

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();
  }
});


getCheckedRow(tableName)


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


Параметр:

НазваниеТипОбязательныйДефолтное значение
tableNameStringДН


Возврат:

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


Пример:

getCheckedRow
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Условие в формате закодированного запроса.


Пример:

getQuery
; (() => {
  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Список таблиц


Пример:

getTablesName
; (() => {
  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.


Параметры:

НазваниеТипОбязательныйДефолтное значение
tableNameStringДН


Возврат:

ТипОписание
VoidДанный метод не возвращает значение.


Пример:

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

  • No labels