delete-field

Beschreibung

Wird ausgelöst, wenn ein Feld entfernt wird

Verwendung

"delete-field": ({
    area: string,
    id: string | number
}) => boolean | void;

Parameter

Der Callback der Aktion erhält ein Objekt mit den folgenden Parametern:

• area - (erforderlich) der Name des Bereichs, aus dem ein Feld entfernt wird; mögliche Werte: "rows", "columns" oder "values"
• id - (erforderlich) die ID des Feldes, das entfernt wird

Info

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

Beispiel

Im folgenden Beispiel wird die Aktion delete-field über die Methode api.exec() ausgelöst. Das letzte Feld wird aus dem values-Bereich entfernt. Die Methode api.getState() wird verwendet, um den aktuellen Zustand der Pivot-config abzurufen. Die Aktion wird durch einen Button-Klick ausgelöst.

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

//API-Methoden aufrufen: einen bestimmten Wert aus values in config entfernen
function removeLastField() {
    if (table.api) {
        const state = table.api.getState();
        const config = state.config;

        const count = config.values.length;

        if (count) {
            const lastValue = config.values[count - 1];

            table.api.exec("delete-field", {
                area: "values",
                id: lastValue.id, // automatisch generierte ID eines zu config.values hinzugefügten Elements
            });
        }
    }
}

const button = document.createElement("button");

button.addEventListener("click", removeLastField);
button.textContent = "Remove";

document.body.appendChild(button);