Перейти к основному содержимому

getFilter()

Описание

Возвращает объект с критериями, заданными для фильтрации данных

Использование

getFilter(id?: string): {cell, rules};

Параметры

  • id - (необязательный) идентификатор листа. Если не указан, метод вызывается для текущего листа

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

Метод возвращает объект с критериями фильтрации. Объект включает два атрибута:

  • cell - диапазон ячеек, к которому применяется фильтрация
  • rules - массив объектов с правилами фильтрации

Пример

const spreadsheet = new dhx.Spreadsheet("spreadsheet", {});
spreadsheet.parse(data);

// получает критерии фильтрации для текущего листа
const filter = spreadsheet.getFilter(); // -> {cell:"A1:A8", rules: [{…}, {…}, {…}, {…}, {…}]}

Журнал изменений: Добавлено в v5.0

Полезная статья: Фильтрация данных