update-config

Beschreibung

Wird ausgelöst, wenn Zeilen, Spalten oder Aggregationsfunktionen über die Pivot-Benutzeroberfläche geändert werden

Die Aktion ist nützlich, um die Aggregationskonfiguration eines Benutzers zu speichern, damit sie beim nächsten Verwenden des Widgets angewendet werden kann und der Benutzer dort fortfahren kann, wo er aufgehört hat.

Verwendung

"update-config": ({
    rows: string[],
    columns: string[],
    values: [],
    filters: {}
}) => boolean | void;

Parameter

Der Callback der Aktion nimmt ein Objekt mit den verarbeiteten config-Parametern entgegen:

• rows - Zeilen der Pivot-Tabelle. Ein Objekt mit der Feld-ID und einer Methode zur Datenextraktion; die Objektparameter sind folgende:
  • field - die ID eines Feldes
  • method - eine Methode zur Datenextraktion (für zeitbasierte Datenfelder)
• columns - definiert die Spalten der Pivot-Tabelle. Es handelt sich um ein Objekt mit der Feld-ID und einer Methode zur Datenextraktion; die Objektparameter sind folgende:
  • field - die ID eines Feldes
  • method - definiert eine Methode zur Datenextraktion (für zeitbasierte Datenfelder). Standardmäßig stehen Methoden für zeitbasierte Felder (Typ date) mit folgenden Werten zur Verfügung: "year", "quarter", "month", "week", "day", "hour", "minute"
• values - definiert die Datenaggregation für die Zellen der Pivot-Tabelle. Es handelt sich um ein Objekt, das die Feld-ID und die Methode zur Datenaggregation enthält. Die Objektparameter sind folgende:
  • field - die ID eines Feldes
  • method - definiert eine Methode zur Datenextraktion; zu Methoden und möglichen Optionen siehe Methoden anwenden
• filters - (optional) definiert, wie Daten in der Tabelle gefiltert werden; es handelt sich um ein Objekt mit Feld-IDs und der Datenaggregationsmethode. Die Beschreibung des filter-Objekts finden Sie hier: config

Info

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

Rückgabewert

Der Callback kann einen booleschen Wert oder void zurückgeben.
Gibt die Event-Handler-Funktion false zurück, wird die Operation, die das Event ausgelöst hat, blockiert und der update-config-Vorgang wird angehalten.

Beispiel

const table = new pivot.Pivot("#root", {
    fields,
    data: dataset,
    config: {
        rows: ["studio", "genre"],
        columns: [],
        values: [
            {
                field: "title",
                method: "count"
            },
            {
                field: "score",
                method: "max"
            }
        ]
    }
});
//das Config-Objekt in die Konsole ausgeben
table.api.on("update-config", (config) => {
    console.log("Config has changed", config);
});

Verwandte Artikel: api.intercept()