open-filter

Beschreibung

Wird ausgelöst, wenn ein Filter für ein Feld aktiviert wird

Verwendung

"open-filter": ({
    id: string | null,
    area?: "values" | "rows" | "columns"
}) => boolean | void;

Parameter

Der Callback der Aktion nimmt die folgenden Parameter entgegen:

• area - der Bereich, in dem ein Feld angewendet wird ("rows", "columns", "values")
• id - die ID eines Feldes; wenn es ein einzelnes id-Argument mit dem Wert null gibt, wird der Filter geschlossen.

Info

Für die Verarbeitung der internen Events können Sie die Event-Bus-Methoden verwenden.

Rückgabewert

Die Funktion kann entweder einen booleschen Wert oder void zurückgeben. Wenn sie false zurückgibt, wird die betreffende Event-Operation angehalten.

Beispiel

Das folgende Beispiel zeigt, wie das Konfigurationsfenster beim Schließen der Filterbox ausgeblendet werden kann:

const table = new pivot.Pivot("#root", {
    fields,
    data: dataset,
    config: {
        rows: ["studio", "genre"],
        columns: [],
        values: [
            {
                field: "title",
                method: "count"
            },
            {
                field: "score",
                method: "max"
            }
        ]
    }
});

table.api.on("open-filter", (ev) => {
    if(!ev.id) {
        table.api.exec("show-config-panel", {
            mode: false
        });
    }    
});

Im nächsten Beispiel wird die ID des Feldes, für das der Filter aktiviert ist, in der Konsole ausgegeben:

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("open-filter", (ev) => {
    console.log("Die Feld-ID, für die der Filter aktiviert ist:", ev.id);
});