Zum Hauptinhalt springen

template

Beschreibung​

Die Funktion template ermöglicht es, ein Template auf die Kopf- und Datenzellen der Tabelle anzuwenden.

Verwendung​

Für Datenzellen:

pivot.template({value, method, row, column}) => string;

Für Kopfzellen:

pivot.template({value, field, method, cell, column}) =>  string;

Parameter​

Für Datenzellen akzeptiert die Funktion die folgenden Parameter:

  • value (any) - (erforderlich) roher Zellenwert
  • method (string) - (erforderlich) eine Methode oder ein Prädikat, das für eine Spalte verwendet wird
  • row - (erforderlich) ein Objekt mit Zeilendaten:
    • id (number) - (erforderlich) Zeilen-ID
    • values (array) - (erforderlich) ein Array mit Zeilendaten
    • open (boolean)- (optional) Zweigstatus
    • $level (boolean)- (optional) Zweigindex
  • column - (erforderlich) ein Objekt mit Spaltendaten:
    • id (number) - (erforderlich) die ID einer Spalte
    • cell (any) - (optional) ein Template mit dem Zellinhalt (siehe Templates über den Template-Helper hinzufügen)
    • template - (optional) das Template, das über die Eigenschaft tableShape definiert wird
    • fields (array) - (optional) definiert Felder in der hierarchischen Spalte im Baumstruktur-Modus. Gibt die Felder an, die in dieser Spalte auf verschiedenen Ebenen angezeigt werden
    • field - (optional) eine Zeichenkette, die die ID eines Felds darstellt
    • method (string) - (optional) eine Methode, sofern für ein Feld in dieser Spalte definiert
    • methods (array) - (optional) definiert Methoden, die auf Felder in der hierarchischen Spalte im Baumstruktur-Modus angewendet werden
    • format (string or object) - (erforderlich) Datumsformat oder Zahlenformat (siehe Formate auf Felder anwenden)
    • isNumeric (boolean) - (optional) gibt an, ob eine Spalte numerische Werte enthält
    • isTotal (boolean) - (optional) gibt an, ob es sich um eine Gesamtspalte handelt
    • area (string) - (optional) der Bereich, in dem die Spalte gerendert wird: "rows", "columns", "values"
    • header- (optional) ein Array von Kopfzellen mit den folgenden Eigenschaften für jede Zelle:
      • text (string) - (optional) Zellentext, formatierter Wert oder mit einem Prädikat-Template verarbeiteter Wert
      • rowspan (number) - (optional) die Anzahl der Zeilen, die eine Kopfzeile überspannen soll
      • colspan (number) - (optional) die Anzahl der Spalten, die eine Kopfzeile überspannen soll
      • value (any) - (erforderlich) roher Wert, wenn eine Zelle zum Bereich "columns" gehört
      • field (string) - (erforderlich) ein Feld, dessen Wert angezeigt wird, wenn eine Zelle zum Bereich "columns" gehört
      • method (string) - (erforderlich) das Feld-Prädikat, wenn eine Zelle zum Bereich "columns" gehört und ein Prädikat definiert ist
      • format (string or object) - Datumsformat oder Zahlenformat (siehe Formate auf Felder anwenden)

Für Kopfzellen sind die Funktionsparameter wie folgt:

  • value (any) - (erforderlich) roher Zellenwert
  • method (string) - (optional) ein Prädikat, das für eine Spalte verwendet wird
  • field (string) - (optional) ein Feld, dessen Wert in einer Zelle angezeigt wird
  • cell - (erforderlich) ein Objekt mit Zellendaten:
    • text (string) - (optional) Zellentext, formatierter Wert oder mit einem Prädikat-Template verarbeiteter Wert
    • rowspan (number) - (optional) die Anzahl der Zeilen, die eine Kopfzeile überspannen soll
    • colspan (number) - (optional) die Anzahl der Spalten, die eine Kopfzeile überspannen soll
    • value (any) - (erforderlich) roher Wert, wenn eine Zelle zum Bereich "columns" gehört
    • field (string) - (erforderlich) ein Feld, dessen Wert angezeigt wird, wenn eine Zelle zum Bereich "columns" gehört
    • method (string) - (erforderlich) ein Feld-Prädikat, wenn eine Zelle zum Bereich "columns" gehört und ein Prädikat definiert ist
    • format (string or object) - (erforderlich) Datumsformat oder Zahlenformat (siehe Formate auf Felder anwenden)
  • column - (erforderlich) ein Objekt mit Spaltendaten (identisch mit dem für die Datenzelle)

Beispiel​

Das folgende Snippet zeigt, wie Templates über den pivot.template-Helper definiert werden. Der Helper wird unmittelbar vor dem Rendern der Tabelle angewendet, indem das Ereignis render-table mithilfe der Methode api.intercept() abgefangen wird.

Das Snippet demonstriert, wie Sie Symbole hinzufügen können zu:

  • Datenzellen basierend auf ihrem Feld (id, user_score) (das Template fügt Flaggen- und Stern-Symbole hinzu)
  • den Kopfzellen-Labels basierend auf dem Feldnamen (zum Beispiel wird bei dem Feld "id" das Globus-Symbol neben dem Kopfzellenwert hinzugefügt)
  • den Spaltenköpfen basierend auf dem Wert (farbige Pfeil-Indikatoren werden hinzugefügt)

Verwandte Artikel:

Need more help?Contact Support