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

apply-filter

Описание

Срабатывает при применении фильтра

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

"apply-filter": ({
rule: {}
}) => boolean | void;

Параметры

Калбэк действия принимает объект со следующими параметрами:

  • rule - любой объект конфигурации фильтра со следующими параметрами:
    • field - (обязательный) идентификатор поля, к которому будет применён фильтр
    • filter - (обязательный) тип фильтра:
      • для текстовых значений: equal, notEqual, contains, notContains, beginsWith, notBeginsWith, endsWith, notEndsWith
      • для числовых значений: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, contains, notContains
      • для типов дат: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, between, notBetween
    • value - (необязательный) значение для фильтрации
    • includes - (необязательный) массив значений для отображения из тех, что уже отфильтрованы; доступно для текстовых и датовых значений
информация

Для обработки внутренних событий можно использовать методы Event Bus

Пример

const table = new pivot.Pivot("#root", {
fields,
data,
config: {
rows: ["studio", "genre"],
columns: [],
values: [
{
field: "title",
method: "count"
},
{
field: "score",
method: "max"
}
]
}
});
//вывод в консоль метки поля, к которому был применён фильтр
table.api.on("apply-filter", (ev) => {
console.log("The field to which filter was applied:", ev.rule.field);
});

Связанные статьи: api.on()