Page History

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

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

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

Пример

This class provides methods to configure lists. Use these methods to manipulate them, for example, in the UI actions.

Global variable usage

Within any list, you can use the predefined global variable.

Description

Example:

window.currentUiAction

s_list.addErrorMessage(message)

This method displays an error toast message in the bottom right corner.

Parameter(s):

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

Параметры:

Return Возвращаемое значение:

ExampleПример:

s_list.addErrorMessage('PleaseВведите enterадрес aэлектронной validпочты email address using the following formatв формате: joe@example.com');

s_list.addInfoMessage(message, durationMilliseconds)

This method displays info messages when working with lists. They appear in the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameter(s):

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

Параметры:

ReturnВозвращаемое значение:

ExampleПример:

s_list.addInfoMessage('LinkСсылка скопирована copiedв toбуфер clipboardобмена', 2000);

s_list.addSuccessMessage(message, durationMilliseconds)

This method displays success messages when working with lists. They appear in the bottom right corner. The message disappears after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameter(s):

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

Параметры:

ReturnВозвращаемое значение:

Example Пример:

s_list.addSuccessMessage('RecordЗапись wasуспешно successfully updatedобновлена!', 3000);

s_list.addWarningMessage(message, durationMilliseconds)

This method displays warning messages when working with lists. They appear in the bottom right corner. The messages disappear after a certain period of time. Specify this period in milliseconds in the second parameter.

Parameter(s):

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

Параметры:

ReturnВозвращаемое значение:

ExampleПример:

s_list.addWarningMessage('ThisЭта recordзапись hasбыла beenизменена modified by another userдругим пользователем', 3000);

s_list.deleteRows(tableName, sysIds)

Use this method to delete one or more selected rows in the table.

Parameter(s):

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

Параметры:

ReturnВозвращаемое значение:

ПримерExample:

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)

Use this method to get information about the strings that are checked on the list.

Parameter(s):

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

Параметр:

ReturnВозвращаемое значение:

Пример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);
  });
}

s_list.getQuery()

This method returns the list condition.

Return:

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

Возвращаемое значение:

ПримерExample:

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

This method returns a list of the tables.

Return:

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

Возвращаемое значение:

ПримерExample:

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

This method refreshes data on the list specified in the tableName parameter.

Parameter(s):

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

Параметр:

ReturnВозвращаемое значение:

ExampleПример:

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