API Übersicht

Kanban Konstruktor

new kanban.Kanban("#root", {
    // Konfigurationsparameter
});

Parameter:

• der HTML-Container (die ID des Containers)
• ein Objekt mit Konfigurationsparametern (Details hier)

Toolbar Konstruktor

new kanban.Toolbar("#toolbar", {
    // Konfigurationsparameter
});

Parameter:

• der HTML-Container (die ID des Containers)
• ein Objekt mit Konfigurationseinstellungen (Details hier)

Kanban Methoden

Name	Beschreibung
addCard()	Fügt eine neue Karte in das Kanban-Board ein
addColumn()	Fügt dem Kanban-Board eine neue Spalte hinzu
addComment()	Fügt einen neuen Kommentar in die angegebene Karte mittels ihrer ID ein.
addLink()	Fügt ein neues Link-Element in das Kanban-Board ein.
addRow()	Fügt dem Kanban-Board eine neue Zeile hinzu
deleteCard()	Löscht eine bestimmte Karte aus dem Kanban-Datenspeicher.
deleteColumn()	Löscht eine angegebene Spalte aus dem Kanban-Datenspeicher.
deleteComment()	Entfernt einen Kommentar von einer Karte anhand seiner ID
deleteLink()	Löscht den angegebenen Link aus dem Kanban-Datenspeicher.
deleteRow()	Löscht die angegebene Zeile aus dem Kanban-Datenspeicher.
destructor()	Löscht alle HTML-Elemente des Kanban-Boards und entfernt alle zugehörigen Ereignishandler.
duplicateCard()	Erstellt eine Kopie einer Karte basierend auf der angegebenen ID
getAreaCards()	Ruft ein Array mit Datenobjekten aller Karten in der angegebenen Spalte (und Zeile) ab.
getCard()	Ruft das Datenobjekt einer Karte anhand ihrer angegebenen ID ab
getSelection()	Gibt ein Array mit der ID bzw. den IDs der ausgewählten Karte(n) zurück
moveCard()	Verschiebt eine Karte in eine angegebene Spalte (und Zeile).
moveColumn()	Verschiebt eine Spalte an eine neue Position innerhalb des Boards.
moveRow()	Verschiebt eine Zeile an eine neue Position innerhalb des Boards.
parse()	Lädt Daten in das Kanban-Board
redo()	Führt die Aktion erneut aus, die durch die undo Methode rückgängig gemacht wurde
scroll()	Bewegt die Kanban-Ansicht zu einem bestimmten Element
selectCard()	Markiert eine Karte basierend auf der angegebenen ID.
serialize()	Wandelt die Kanban-Daten in ein JSON-Format um.
setConfig()	Aktualisiert das Kanban mit neuen Konfigurationseinstellungen
setEdit()	Schaltet den Kanban-Karten-Editor ein oder aus
setLocale()	Setzt eine neue Lokalisierung für die Kanban-Komponente
setSearch()	Findet Karten basierend auf den angegebenen Suchkriterien
setSort()	Sortiert Karten basierend auf den angegebenen Kriterien
setTheme()	Wendet dynamisch ein neues Theme auf das Kanban-Board an (initialisiert es neu).
undo()	Macht die letzte Operation im Kanban rückgängig
unselectCard()	Hebt die Auswahl der Karte(n) auf, die durch ihre ID identifiziert werden.
updateCard()	Aktualisiert die Daten einer Karte anhand ihrer ID
updateColumn()	Ändert die Daten einer Spalte anhand ihrer ID
updateComment()	Ändern Sie einen Kommentar einer Karte, indem Sie dessen ID angeben
updateRow()	Ändert die Daten einer Zeile basierend auf ihrer ID.

Kanban interne API

Event Bus Methoden

Name	Beschreibung
api.exec()	Diese Methode ermöglicht es Ihnen, interne Ereignisse innerhalb des Kanban-Boards auszulösen.
api.intercept()	Ermöglicht das Abfangen und Blockieren interner Ereignisse, bevor sie eintreten.
api.on()	Ermöglicht das Anhängen eines Handlers an interne Ereignisse
api.setNext()	Ermöglicht das Einfügen einer bestimmten Aktion in die Event Bus-Sequenz.

Export Methoden

Name	Beschreibung
export.json()	Speichert die Kanban-Daten als JSON-Datei

State Methoden

Name	Beschreibung
api.getReactiveState()	Ruft ein Objekt mit den reaktiven Eigenschaften des Kanban-Boards ab.
api.getState()	Ruft ein Objekt ab, das die Eigenschaften des StateStore des Kanban enthält.
api.getStores()	Ruft ein Objekt mit den DataStore-Eigenschaften des Kanban ab.

Kanban Events

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, sobald eine neue Zeile hinzugefügt wird
add-vote	Wird ausgelöst, sobald ein Benutzer 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 zu einer Karte gelöscht wird
delete-link	Wird ausgelöst, wenn ein Link gelöscht wird
delete-row	Wird ausgelöst, wenn eine Zeile entfernt wird
delete-vote	Wird ausgelöst, wenn ein Benutzer eine Stimme von einer Karte entfernt
drag-card	Dieses Event wird ausgelöst, sobald eine Karte per Drag-and-Drop verschoben wird.
duplicate-card	Wird ausgelöst, wenn eine Karte dupliziert wird
end-drag-card	Wird ausgelöst, wenn eine Karten-Zieh-Aktion 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
scroll	Wird ausgelöst, wenn zu bestimmten Elementen gescrollt wird
select-card	Wird ausgelöst, wenn eine Karte ausgewählt wird
set-edit	Wird ausgelöst, wenn der Editor umgeschaltet wird
set-search	Wird ausgelöst, wenn eine Kartensuche ausgeführt wird
set-sort	Wird ausgelöst, sobald Karten sortiert werden.
start-drag-card	Wird ausgelöst, wenn mit dem Ziehen einer Karte begonnen 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, sobald Spaltendaten aktualisiert werden.
update-comment	Wird ausgelöst, wenn ein Kommentar aktualisiert wird
update-row	Wird ausgelöst, wenn die Daten einer Zeile aktualisiert werden

Kanban Eigenschaften

Name	Beschreibung
cardHeight	Optional. Definiert die Höhe der Karten.
karten	Optional. Ein Array von Objekten, die die Kartendaten enthalten
cardShape	Optional. Einstellungsobjekt, das steuert, wie Karten dargestellt werden.
cardTemplate	Optional. Erzeugt und wendet eine benutzerdefinierte HTML-Vorlage für die Karte an.
columnKey	Optional. Gibt an, zu welcher Spalte eine Karte gehört.
Spalten	Optional. Ein Array von Objekten, die die Spaltendaten enthalten
columnShape	Optional. Einstellungsobjekt zur individuellen Anpassung des Aussehens der Spalten
currentUser	Optional. Repräsentiert die ID des aktuellen Benutzers
editor	Optional. Enthält Einstellungen zur Anpassung des Kanban-Editors
editorAutoSave	Veraltet! Optional. Aktiviert/deaktiviert den Autosave-Modus
editorShape	Optional. Ein Array von Objekten, die die Einstellungen zur Steuerung des Aussehens und Verhaltens des Kanban-Editors definieren.
history	Optional. Steuert, ob die Historie der Änderungen verfolgt wird
links	Optional. Dies ist ein Array von Objekten, das die Links-Daten enthält.
locale	Optional. Ein Objekt, das eine benutzerdefinierte Locale für Kanban definiert.
readonly	Optional. Steuert, ob das Bearbeiten, Hinzufügen, Auswählen und Ziehen von Karten aktiviert oder deaktiviert ist.
renderType	Optional. Gibt an, wie die Karten dargestellt werden.
rowKey	Optional. Legt fest, wie eine Karte einer Reihe zugewiesen wird.
rows	Optional. Ein Array von Objekten, das die Daten der Zeilen (Swimlanes) enthält.
rowShape	Optional. Ein Objekt mit Einstellungen zur Anpassung des Erscheinungsbilds von Zeilen
scrollType	Optional. Gibt an, wie das Scrollen funktioniert.
theme	Optional. Definiert ein Theme, das auf das Kanban-Board angewendet wird

Toolbar Methoden

Name	Beschreibung
destructor()	Räumt auf, indem alle Toolbar-HTML-Elemente entfernt und alle zugehörigen Ereignisse abgehängt werden.
setConfig()	Aktualisiert die Toolbar mit neuen Konfigurationseinstellungen
setLocale()	Aktualisiert die Toolbar von Kanban mit einer neuen Spracheinstellung

Toolbar Eigenschaften

Name	Beschreibung
api	Erforderlich. Ein Objekt, das die interne API von Kanban repräsentiert
items	Optional. Ein Array, das die auf der Kanban Toolbar angeordneten Steuerelemente enthält.
locale	Optional. Ein Objekt, das eine benutzerdefinierte Locale für die Toolbar definiert.
theme	Optional. Gibt das auf die Toolbar angewendete Theme an.

Allgemeine Einstellungen

Name	Beschreibung
$meta	Ein Objekt mit zusätzlichen Einstellungen zur Anpassung von Kanban-Methoden und -Ereignissen

RestDataProvider API

RestDataProvider Methoden

Name	Beschreibung
getCards()	Ruft ein Promise mit den Kartendaten ab
getColumns()	Ruft ein Promise mit den Spalten-Daten ab
getLinks()	Ruft ein Promise mit den Link-Daten ab
getRows()	Ruft ein Promise mit den Zeilendaten ab
getUsers()	Ruft ein Promise mit den Benutzerdaten ab
send()	Diese Methode übernimmt das Senden der erforderlichen HTTP-Anfragen an den Server und liefert ein Promise zurück, das je nach Anfragetyp Daten enthalten kann.

RestDataProvider Routen

Name	Beschreibung
GET /cards	Ruft Informationen zu allen Karten ab und gibt ein JSON-Objekt mit einem Array von Kartenobjekten zurück.
GET /columns	Ruft Informationen über alle Spalten ab und gibt ein JSON-Objekt mit einem Array von Spaltendaten zurück.
GET /links	Ruft Informationen über alle Links ab und gibt ein JSON-Objekt zurück, das ein Array von Link-Objekten enthält.
GET /rows	Ruft Daten für alle Zeilen ab und gibt ein JSON-Objekt zurück, das ein Array von Zeilen- (Swimlane-) Datenobjekten enthält.
GET /users	Ruft Daten für alle Benutzer ab und gibt ein JSON-Objekt zurück, das ein Array von Benutzerobjekten enthält.
GET /uploads	Ruft die angegebene Binärdatei vom Server ab
POST /cards	Fügt eine neue Karte hinzu und antwortet mit einem JSON-Objekt, das die ID der Karte enthält.
POST /cards/{cardId}/comments	Fügt der angegebenen Karte einen oder mehrere neue Kommentare 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	Fügt einen neuen Link hinzu und gibt ein JSON-Objekt mit der neuen Link-ID zurück
POST /rows	Fügt eine neue Zeile hinzu und antwortet mit einem JSON-Objekt, das die ID der Zeile enthält.
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 die Daten 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}	Dieser Endpunkt aktualisiert einen bestehenden Kommentar innerhalb einer Karte und gibt ein JSON-Objekt mit der ID des aktualisierten Kommentars zurück.
PUT /columns	Aktualisiert die Details einer bestimmten Spalte und gibt ein leeres JSON-Objekt zurück.
PUT /columns/{id}/move	Ändert die Position einer Spalte, indem sie an eine bestimmte Stelle verschoben wird.
PUT /rows	Aktualisiert die Daten für eine bestimmte Zeile (Swimlane) und gibt ein leeres JSON-Objekt zurück.
PUT /rows/{id}/move	Ändert die Position einer Zeile, indem sie an eine bestimmte Stelle verschoben wird.
DELETE /cards	Entfernt Daten von einer Karte
DELETE /cards/{cardId}/comments/{cardId}	Löscht 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	Entfernt die Daten einer Spalte
DELETE /links	Entfernt einen Link-Eintrag
DELETE /rows	Entfernt eine Zeile (Swimlane) aus den Daten.