Zum Hauptinhalt springen

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

NameBeschreibung
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

NameBeschreibung
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

NameBeschreibung
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

NameBeschreibung
add-fieldWird ausgelöst, wenn ein neues Feld zum Bereich Zeilen, Spalten oder Werte hinzugefügt wird
apply-filterWird ausgelöst, wenn ein Filter angewendet wird
delete-fieldWird ausgelöst, wenn ein Feld entfernt wird
move-fieldWird ausgelöst, wenn Felder neu angeordnet werden
open-filterWird ausgelöst, wenn ein Filter für ein Feld aktiviert wird
render-tableWird ausgelöst, nachdem die Widget-Konfiguration verarbeitet wurde und unmittelbar bevor die Tabelle gerendert wird
show-config-panelWird ausgelöst, wenn sich die Sichtbarkeit des Konfigurationspanels ändert
update-configWird ausgelöst, wenn Zeilen, Spalten oder Aggregationsfunktionen über die Pivot-Benutzeroberfläche geändert werden
update-fieldWird ausgelöst, wenn ein Feld aktualisiert wird

Pivot-Eigenschaften

NameBeschreibung
columnShapeOptional. Konfiguriert das Aussehen und Verhalten der Pivot-Spalten
configOptional. Definiert die Struktur der Pivot-Tabelle und die Art der Datenaggregation
configPanelOptional. Steuert die Sichtbarkeit des Konfigurationspanels in der Benutzeroberfläche
dataOptional. Ein Array von Objekten mit Daten für die Pivot-Tabelle
fieldsOptional. Ein Array von Objekten mit Feldern für die Pivot-Tabelle
headerShapeOptional. Konfiguriert das Aussehen und das Verhalten der Kopfzeilen in der Pivot-Tabelle
limitsOptional. Legt die maximale Anzahl von Zeilen und Spalten im endgültigen Datensatz fest
localeOptional. Ein Objekt für eine benutzerdefinierte Locale von Pivot
methodsOptional. Definiert benutzerdefinierte mathematische Methoden für die Datenaggregation
predicatesOptional. Stellt benutzerdefinierte Vorverarbeitungsfunktionen für die Datendimensionen (Zeilen, Spalten) bereit
readonlyOptional. Aktiviert/deaktiviert den Nur-Lese-Modus
tableShapeOptional. Konfiguriert das Aussehen der Pivot-Tabelle