Arbeiten mit Datatables

Datentabelle

Eine Datentabelle wird mit dem Objekt Alvine.Package.UI.Dialog.Datatable erstellt. Das Objekt enthält eine Vielzahl von Einstellmöglichkeiten. Eine Übersicht ist in der Dokumentation zur Console zu finden.

Der wichtigste Parameter ist die URL. Diese wird über die Einstellung data-url definiert und setzt sich aus dem API-Aufruf und verschiedenen Platzhaltern zusammen.

/api/.../search?q=${query}&orderby={orderby}&count=${count}&page=${page}

Die Platzhalter müssen folgendermaßen notiert werden: ${...}

Platzhalter	Beschreibung
query	Suchanfrage
orderby	Sortierung
count	Anzahl
offset	Offset
page	Seite

Soll gleich Ergebnisse angezeigt werden, so muss eine Standardabfrage definiert werden. Die Standard-Abfrage - wenn kein Filter gesetzt ist - wird über die Einstellung default-query übergeben. Meistens ist hier die Abfrage der ID

In der Konsole ist das Query-Argument für die übergabe an die API query, dies muss in Platform überschrieben werden. In den Optionen muss für den Schlüssel argument-query der Wert q gesetzt werden.

Werden im Schlüssel columns keine Spalten definiert, so werden alle Einträge aus dem zurückgegebenen Datensatz aus der ersten Zeile ausgewertet. Sollen die Spalten nicht automatisch hinzugefügt werden, so muss columns auf {} gesetzt werden.

Spalten können entweder als Zeichenkette oder als Objekt definiert werden. Wird eine Zeichenkette angegeben, so ist das der Schlüssel und das Label der Spalte. Über ein Objekt lassen sich die Einstellungen aus der Tabelle defifinieren.

Eigenschaft	Beschreibung
label	Tabellenüberschrift
fixed	Spalte kann nicht ausgeblendet werden
visibility	Sichtbarkeit
orderby	Kann sortiert werden
css-class	CSS-Klasse im TD
map	Mapping
function	Funktion

new Alvine.Package.UI.Dialog.Datatable({
        'data-url': '/my-api?q=${query}&orderby=${orderby}&count=${count}&page=${page}',
        'default-query': 'id>0',
        'argument-query': 'q',


    });

Wurde noch kein Filter ausgewählt, so muss eine Standardabfrage