api.getState()

Beschreibung

Gibt ein Objekt mit den StateStore-Eigenschaften von Pivot zurück

Verwendung

api.getState(): object;

Rückgabewert

Die Methode gibt ein Objekt mit folgenden Parametern zurück:

{
    config: {}, // aktuelle Konfiguration (rows, columns, values, filters)
    activeFilter: {}, // aktives Filter-Objekt (sofern ein Filter geöffnet ist) 
    columnShape: {}, // Konfiguration der Pivot-Spalten
    data: [], // Quelldaten
    fields: [], // Felder-Array
    filters: {}, // Filterregeln
    headerShape: {}, // Einstellungen des Tabellen-Headers
    predicates: {}, // verfügbare Prädikate je Feld
    limits: {}, // maximales Limit für die Anzahl der Zeilen und Spalten im Datensatz
    methods: {}, // Methoden zur Datenaggregation
    tableShape: {}, // Tabellen-Einstellungen (Größen, Gesamtzeile, Templates)
    tableConfig: {}, // Tabellen-Konfigurationseinstellungen (Spalten, Daten, Größen, Baumansicht, Fußzeile)
    configPanel: boolean, // Status der Sichtbarkeit des Konfigurationspanels
    readonly: boolean, // ob der schreibgeschützte Modus aktiviert ist
}  

Beispiel

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

const { config } = table.api.getState();
console.log(config); //den Konfigurations-State in der Konsole ausgeben