API Übersicht
Kanban Konstruktor
new kanban.Kanban("#root", {
// Konfigurationsparameter
});
Parameter:
- ein HTML-Container (die ID des HTML-Containers)
- ein Objekt mit den Konfigurationsparametern (hier prüfen)
Toolbar Konstruktor
new kanban.Toolbar("#toolbar", {
// Konfigurationsparameter
});
Parameter:
- ein HTML-Container (die ID des HTML-Containers)
- ein Objekt mit den Konfigurationsparametern (hier prüfen)
Kanban Methoden
| Name | Beschreibung |
|---|---|
| addCard() | Fügt eine neue Karte in das Kanban-Board ein |
| addColumn() | Fügt dem Kanban eine neue Spalte hinzu |
| addComment() | Fügt der angegebenen Karte anhand ihrer ID einen neuen Kommentar hinzu |
| addLink() | Fügt einen neuen Link in das Kanban-Board ein |
| addRow() | Fügt eine neue Zeile in das Kanban-Board ein |
| deleteCard() | Entfernt die angegebene Karte aus dem Datenspeicher des Kanban |
| deleteColumn() | Entfernt die angegebene Spalte aus dem Datenspeicher des Kanban |
| deleteComment() | Löschen Sie einen Kommentar einer Karte anhand seiner ID |
| deleteLink() | Entfernt den angegebenen Link aus dem Datenspeicher von Kanban |
| deleteRow() | Entfernt die angegebene Zeile aus dem Datenspeicher des Kanban |
| destructor() | Entfernt alle HTML-Elemente des Kanban und löst alle zugehörigen Ereignisse. |
| duplicateCard() | Dupliziert eine Karte anhand der angegebenen ID |
| getAreaCards() | Gibt ein Array mit Datenobjekten aller Karten der angegebenen Spalte (und Zeile) zurück |
| getCard() | Ruft das Datenobjekt der Karte anhand der angegebenen ID ab |
| getColumnCards() | Gibt ein Array zurück, das die Datenobjekte aller Karten in der angegebenen Spalte speichert |
| getSelection() | Gibt ein Array mit der ID bzw. den IDs der ausgewählten Karte(n) zurück |
| moveCard() | Verschiebt eine Karte in die angegebene Spalte (und Zeile) |
| moveColumn() | Verschiebt eine Spalte an eine neue Position |
| moveRow() | Verschiebt eine Zeile an eine neue Position |
| parse() | Parst Daten in Kanban |
| redo() | Wiederholt die Aktion, die durch die Undo-Aktion rückgängig gemacht wurde. |
| scroll() | Scrollt das Kanban auf das angegebene Element |
| selectCard() | Wählt eine Karte anhand der angegebenen ID aus |
| serialize() | Serialisiert die Kanban-Daten in JSON |
| setConfig() | Setzt neue Konfigurationsparameter für das Kanban |
| setEdit() | Schaltet einen Editor im Kanban um |
| setLocale() | Wendet eine neue Locale auf Kanban an |
| setSearch() | Sucht nach Karten anhand der angegebenen Parameter |
| setSort() | Sortiert Karten nach den angegebenen Parametern |
| undo() | Macht die letzte Operation im Kanban rückgängig |
| unselectCard() | Hebt die Auswahl von Karte(n) anhand ihrer ID auf |
| updateCard() | Aktualisiert die Kartendaten anhand ihrer ID |
| updateColumn() | Aktualisiert die Spaltendaten anhand ihrer ID |
| updateComment() | Aktualisiert einen Kommentar einer Karte anhand seiner ID |
| updateRow() | Aktualisiert die Zeilendaten anhand ihrer ID |
Kanban interne API
Event Bus Methoden
| Name | Beschreibung |
|---|---|
| api.detach() | Ermöglicht das Entfernen/Abtrennen eines Event-Listeners |
| api.exec() | Ermöglicht das Auslösen interner Ereignisse |
| api.intercept() | Ermöglicht das Abfangen und Verhindern von internen Ereignissen |
| api.on() | Ermöglicht das Anhängen eines Handlers an interne Ereignisse |
| api.setNext() | Ermöglicht das Hinzufügen einer Aktion in die Reihenfolge des Event Bus |
Export Methoden
| Name | Beschreibung |
|---|---|
| export.json() | Exportiert Kanban-Daten in eine JSON-Datei |
Status Methoden
| Name | Beschreibung |
|---|---|
| api.getReactiveState() | Gibt ein Objekt mit den reaktiven Eigenschaften von Kanban zurück |
| api.getState() | Gibt ein Objekt mit den StateStore-Eigenschaften des Kanban zurück |
| api.getStores() | Gibt ein Objekt mit den DataStore-Eigenschaften des Kanban zurück |
Kanban Ereignisse
| Name | Beschreibung |
|---|---|
| add-card | Wird ausgelöst, wenn eine neue Karte hinzugefügt wird |
| add-column | Wird ausgelöst, wenn eine neue Spalte hinzugefügt wird |
| add-comment | Wird ausgelöst, wenn ein neuer Kommentar hinzugefügt wird |
| add-link | Wird ausgelöst, wenn ein neuer Link hinzugefügt wird |
| add-row | Wird ausgelöst, wenn eine neue Zeile hinzugefügt wird |
| add-vote | Wird ausgelöst, wenn ein Nutzer eine neue Stimme hinzufügt |
| delete-card | Wird ausgelöst, wenn eine Karte entfernt wird |
| delete-column | Wird ausgelöst, wenn eine Spalte entfernt wird |
| delete-comment | Wird ausgelöst, wenn ein Kommentar einer Karte gelöscht wird |
| delete-link | Wird ausgelöst, wenn ein Link entfernt wird |
| delete-row | Wird ausgelöst, wenn eine Zeile entfernt wird |
| delete-vote | Wird ausgelöst, wenn ein Benutzer eine Stimme von einer Karte löscht |
| drag-card | Wird ausgelöst, wenn eine Karte per Drag & Drop verschoben wird |
| duplicate-card | Wird ausgelöst, wenn eine Karte dupliziert wird |
| end-drag-card | Wird ausgelöst, wenn das Ziehen einer Karte beendet wird |
| move-card | Wird ausgelöst, wenn eine Karte verschoben wird |
| move-column | Wird ausgelöst, wenn eine Spalte verschoben wird |
| move-row | Wird ausgelöst, wenn eine Zeile verschoben wird |
| redo | Wird ausgelöst, wenn die Aktion wiederholt wird, die durch die undo Aktion rückgängig gemacht wurde |
| scroll | Wird ausgelöst, wenn zu den angegebenen Elementen gescrollt wird |
| select-card | Wird ausgelöst, wenn eine Karte ausgewählt wird |
| set-edit | Wird ausgelöst, wenn ein Editor umgeschaltet wird |
| set-search | Wird ausgelöst, wenn nach Karten gesucht wird |
| set-sort | Wird ausgelöst, wenn Karten sortiert werden |
| start-drag-card | Wird ausgelöst, wenn das Ziehen einer Karte gestartet wird |
| rückgängig | Wird ausgelöst, wenn die letzte Operation im Kanban rückgängig gemacht wird |
| unselect-card | Wird ausgelöst, wenn eine Karte abgewählt wird |
| update-card | Wird ausgelöst, wenn Kartendaten aktualisiert werden |
| update-column | Wird ausgelöst, wenn Spaltendaten aktualisiert werden |
| update-comment | Wird ausgelöst, wenn ein Kommentar aktualisiert wird |
| update-row | Wird ausgelöst, wenn Zeilendaten aktualisiert werden |
Kanban Eigenschaften
| Name | Beschreibung |
|---|---|
| cardHeight | Optional. Die Höhe der Karten |
| karten | Optional. Ein Array von Objekten mit den Kartendaten |
| cardShape | Optional. Ein Objekt mit Einstellungen zur Verwaltung des Aussehens der Karten |
| cardTemplate | Optional. Gibt eine neue HTML-Vorlage der Karte zurück und wendet sie an. |
| columnKey | Optional. Definiert die Zugehörigkeit der Karte zur Spalte |
| spalten | Optional. Ein Array von Objekten, das die Spaltendaten enthält |
| columnShape | Optional. Ein Einstellungsobjekt zur Verwaltung des Erscheinungsbilds der Spalten |
| currentUser | Optional. Eine ID des aktuellen Benutzers |
| editor | Optional. Ein Einstellungsobjekt zur Konfiguration des Kanban-Editors |
| editorShape | Optional. Ein Array von Objekten mit Einstellungen zur Verwaltung des Aussehens und der Funktionalität des Kanban-Editors |
| history | Optional. Aktiviert/deaktiviert die Verwaltung der Änderungsverlaufshistorie |
| links | Optional. Ein Array von Objekten, die die Link-Daten enthalten |
| locale | Optional. Ein Objekt für eine benutzerdefinierte Kanban-Lokalisierung |
| readonly | Optional. Aktiviert/deaktiviert das Bearbeiten, Hinzufügen, Auswählen und Ziehen der Karten |
| renderType | Optional. Definiert eine Art der Kartenanzeige |
| rowKey | Optional. Definiert die Zugehörigkeit der Karte zur Zeile |
| zeilen | Optional. Ein Array von Objekten, die die Daten der Zeilen (Swimlanes) enthalten. |
| rowShape | Optional. Ein Objekt mit Einstellungen zur Verwaltung des Erscheinungsbilds der Zeilen |
| scrollType | Optional. Definiert eine Art des Scrollens |
Toolbar Methoden
| Name | Beschreibung |
|---|---|
| destructor() | Entfernt alle HTML-Elemente der Toolbar und trennt alle zugehörigen Ereignisse |
| setConfig() | Setzt neue Konfigurationsparameter der Toolbar |
| setLocale() | Wendet eine neue Locale auf die Toolbar des Kanban an |
Toolbar Eigenschaften
| Name | Beschreibung |
|---|---|
| api | Erforderlich. Ein Objekt mit der internen API von Kanban |
| items | Optional. Ein Array mit Steuerelementen, die in der Toolbar des Kanban angeordnet sind. |
| locale | Optional. Ein Objekt einer benutzerdefinierten Toolbar-Lokalisierung |
Allgemeine Einstellungen
| Name | Beschreibung |
|---|---|
| $meta | Ein Objekt mit zusätzlichen Einstellungen zur Konfiguration von Methoden und Events des Kanban |
RestDataProvider API
RestDataProvider Methoden
| Name | Beschreibung |
|---|---|
| getCards() | Gibt ein Promise mit den Kartendaten zurück |
| getColumns() | Gibt ein Promise mit den Spaltendaten zurück |
| getLinks() | Gibt ein Promise mit den Link-Daten zurück |
| getRows() | Gibt ein Promise mit den Zeilendaten zurück |
| getUsers() | Liefert ein Promise mit den Benutzerdaten |
| send() | Sendet eine erforderliche HTTP-Anfrage an den Server und gibt ein Promise mit oder ohne Daten zurück, abhängig von der Anfrage. |
RestDataProvider Routen
| Name | Beschreibung |
|---|---|
GET /cards | Ruft Daten aller Karten ab und gibt ein JSON-Objekt mit einem Array von Kartenobjekten zurück |
GET /columns | Ruft Daten aller Spalten ab und gibt ein JSON-Objekt mit einem Array von Objekten mit Spaltendaten zurück |
GET /links | Ruft Daten zu allen Links ab und gibt ein JSON-Objekt mit einem Array von Link-Objekten zurück |
GET /rows | Ruft Daten zu allen Zeilen ab und gibt ein JSON-Objekt mit einem Array von Objekten mit Zeilendaten (Swimlanes) zurück. |
GET /users | Ruft Daten aller Benutzer ab und gibt ein JSON-Objekt mit einem Array von Benutzerobjekten zurück |
GET /uploads | Ruft die angeforderte Binärdatei vom Server ab |
POST /cards | Erstellt eine neue Karte und gibt ein JSON-Objekt mit einer neuen Karten-ID zurück. |
POST /cards/{cardId}/comments | Fügt dem Kartenobjekt einen neuen Kommentar hinzu und gibt ein JSON-Objekt mit der ID des neu hinzugefügten Kommentars zurück. |
POST /cards/{cardId}/vote | Fügt der Karte eine neue Stimme hinzu und gibt ein JSON-Objekt mit der ID des abstimmenden Benutzers zurück. |
POST /columns | Fügt eine neue Spalte hinzu und gibt ein JSON-Objekt mit der Spalten-ID zurück |
POST /links | Erstellt einen neuen Link und gibt ein JSON-Objekt mit einer neuen Link-ID zurück. |
POST /rows | Fügt eine neue Zeile hinzu und gibt ein JSON-Objekt mit der Zeilen-ID zurück. |
POST /uploads | Lädt eine Binärdatei auf den Server hoch und gibt ein JSON-Objekt mit der Datei-ID, dem Namen und der URL zurück |
PUT /cards | Aktualisiert Daten auf einer angegebenen Karte und gibt ein leeres JSON-Objekt zurück |
PUT /cards/{id}/move | Verschiebt Karten an eine bestimmte Position |
PUT /cards/{cardId}/comments/{cardId} | Aktualisiert einen Kommentar in einer Karte und gibt ein JSON-Objekt mit der ID des aktualisierten Kommentars zurück. |
PUT /columns | Aktualisiert Daten einer angegebenen Spalte und gibt ein leeres JSON-Objekt zurück |
PUT /columns/{id}/move | Verschiebt eine Spalte an eine angegebene Position |
PUT /rows | Aktualisiert Daten in einer angegebenen Zeile (Swimlane) und gibt ein leeres JSON-Objekt zurück |
PUT /rows/{id}/move | Verschiebt eine Zeile an eine bestimmte Position |
DELETE /cards | Löscht Daten auf einer Karte |
DELETE /cards/{cardId}/comments/{cardId} | Entfernt einen Kommentar von einer Karte |
DELETE /cards/{cardId}/vote | Entfernt eine Stimme von einer Karte und gibt ein JSON-Objekt mit der Benutzer-ID zurück, die die Stimme entfernt hat. |
DELETE /columns | Löscht Daten einer Spalte |
DELETE /links | Löscht Daten zu einem Link |
DELETE /rows | Löscht Daten in einer Zeile (Swimlane) |