apply-filter

Beschreibung

Wird ausgelöst, wenn ein Filter angewendet wird

Verwendung

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

Parameter

Der Callback der Aktion empfängt ein Objekt mit folgenden Parametern:

• rule - ein beliebiges Filter-Konfigurationsobjekt mit den folgenden Parametern:
  • field - (erforderlich) die Feld-ID, auf die der Filter angewendet wird
  • filter - (erforderlich) Filtertyp:
    • für Textwerte: equal, notEqual, contains, notContains, beginsWith, notBeginsWith, endsWith, notEndsWith
    • für numerische Werte: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, contains, notContains
    • für Datumstypen: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, between, notBetween
  • value - (optional) der Wert, nach dem gefiltert werden soll
  • includes - (optional) ein Array von Werten, die aus den bereits gefilterten Einträgen angezeigt werden sollen; verfügbar für Text- und Datumswerte

Info

Zur Verarbeitung der internen Events können Sie die Event-Bus-Methoden verwenden

Beispiel

const table = new pivot.Pivot("#root", {
    fields,
    data,
    config: {
        rows: ["studio", "genre"],
        columns: [],
        values: [
            {
                field: "title",
                method: "count"
            },
            {
                field: "score",
                method: "max"
            }
        ]
    }
});
//Gibt den Namen des Feldes, auf das der Filter angewendet wurde, in der Konsole aus
table.api.on("apply-filter", (ev) => {
    console.log("The field to which filter was applied:", ev.rule.field);
});

Verwandte Artikel: api.on()