API-Übersicht
Pivot-Konstruktor
new pivot.Pivot("#root", {
// Konfigurationsparameter
});
Parameter:
- ein HTML-Container (die ID des HTML-Containers)
- ein Objekt der Konfigurationsparameter (hier prüfen)
Pivot-Methoden
| Name | Beschreibung |
|---|---|
| getTable() | Gewährt Zugriff auf die zugrundeliegende Table-Widget-Instanz in der Pivot-Tabelle |
| setConfig() | Aktualisiert die aktuelle Konfiguration des Pivot-Widgets |
| setLocale() | Wendet eine neue Locale auf Pivot an |
| showConfigPanel() | Zeigt das Konfigurationspanel an oder blendet es aus |
Interne Pivot-API
Event-Bus-Methoden
| Name | Beschreibung |
|---|---|
| api.detach() | Ermöglicht das Entfernen/Abtrennen von Action-Handlern |
| api.exec() | Ermöglicht das Auslösen interner Events |
| api.intercept() | Ermöglicht das Abfangen und Verhindern interner Events |
| api.on() | Ermöglicht das Anhängen eines Handlers an interne Events |
| api.setNext() | Ermöglicht das Hinzufügen einer Aktion in die Event-Bus-Reihenfolge |
State-Methoden
| Name | Beschreibung |
|---|---|
| api.getReactiveState() | Gibt ein Objekt mit den reaktiven Eigenschaften von Pivot zurück |
| api.getState() | Gibt ein Objekt mit den StateStore-Eigenschaften von Pivot zurück |
| api.getStores() | Gibt ein Objekt mit den DataStore-Eigenschaften von Pivot zurück |
Pivot-Events
| Name | Beschreibung |
|---|---|
| add-field | Wird ausgelöst, wenn ein neues Feld zum Bereich Zeilen, Spalten oder Werte hinzugefügt wird |
| apply-filter | Wird ausgelöst, wenn ein Filter angewendet wird |
| delete-field | Wird ausgelöst, wenn ein Feld entfernt wird |
| move-field | Wird ausgelöst, wenn Felder neu angeordnet werden |
| open-filter | Wird ausgelöst, wenn ein Filter für ein Feld aktiviert wird |
| render-table | Wird ausgelöst, nachdem die Widget-Konfiguration verarbeitet wurde und unmittelbar bevor die Tabelle gerendert wird |
| show-config-panel | Wird ausgelöst, wenn sich die Sichtbarkeit des Konfigurationspanels ändert |
| update-config | Wird ausgelöst, wenn Zeilen, Spalten oder Aggregationsfunktionen über die Pivot-Benutzeroberfläche geändert werden |
| update-field | Wird ausgelöst, wenn ein Feld aktualisiert wird |
Pivot-Eigenschaften
| Name | Beschreibung |
|---|---|
| columnShape | Optional. Konfiguriert das Aussehen und Verhalten der Pivot-Spalten |
| config | Optional. Definiert die Struktur der Pivot-Tabelle und die Art der Datenaggregation |
| configPanel | Optional. Steuert die Sichtbarkeit des Konfigurationspanels in der Benutzeroberfläche |
| data | Optional. Ein Array von Objekten mit Daten für die Pivot-Tabelle |
| fields | Optional. Ein Array von Objekten mit Feldern für die Pivot-Tabelle |
| headerShape | Optional. Konfiguriert das Aussehen und das Verhalten der Kopfzeilen in der Pivot-Tabelle |
| limits | Optional. Legt die maximale Anzahl von Zeilen und Spalten im endgültigen Datensatz fest |
| locale | Optional. Ein Objekt für eine benutzerdefinierte Locale von Pivot |
| methods | Optional. Definiert benutzerdefinierte mathematische Methoden für die Datenaggregation |
| predicates | Optional. Stellt benutzerdefinierte Vorverarbeitungsfunktionen für die Datendimensionen (Zeilen, Spalten) bereit |
| readonly | Optional. Aktiviert/deaktiviert den Nur-Lese-Modus |
| tableShape | Optional. Konfiguriert das Aussehen der Pivot-Tabelle |