Zum Hauptinhalt springen

API-Übersicht

To-Do-List-Methoden

NameBeschreibung
addProject()Fügt ein neues Projekt hinzu
addTask()Fügt eine neue Aufgabe zur Liste hinzu
assignUser()Weist einer angegebenen Aufgabe eine Person zu
checkTask()Markiert eine Aufgabe als abgeschlossen
closeInlineEditor()Schließt den Inline-Editor einer Aufgabe/eines Projekts
collapseTask()Klappt eine Aufgabe anhand ihrer ID ein
copyTask()Kopiert eine Aufgabe in die Zwischenablage und fügt sie an der angegebenen Position ein
deleteProject()Entfernt ein Projekt
deleteTask()Entfernt die angegebene Aufgabe aus dem DataStore
destructor()Entfernt alle HTML-Elemente der To Do List und trennt alle zugehörigen Events
eachSelected()Iteriert über alle ausgewählten Aufgaben
existsProject()Prüft, ob das angegebene Projekt im DataStore vorhanden ist
existsTask()Prüft, ob die angegebene Aufgabe im DataStore vorhanden ist
expandTask()Klappt eine reduzierte Aufgabe anhand ihrer ID auf
getChildrenIds()Gibt die IDs der untergeordneten Aufgaben der angegebenen übergeordneten Aufgabe zurück
getParentIds()Gibt die IDs der übergeordneten Aufgaben der angegebenen untergeordneten Aufgabe zurück
getProject()Ruft ein Projektobjekt anhand seiner ID ab
getSelection()Gibt ein Array mit der ID der ausgewählten Aufgabe zurück
getTask()Ruft ein Aufgabenobjekt anhand seiner ID ab
hasChildren()Prüft, ob die angegebene Aufgabe untergeordnete Aufgaben hat
hideCompletedTasks()Wechselt die To Do List in den Modus, in dem abgeschlossene Aufgaben auf der Seite ausgeblendet werden
indentTask()Stuft die Verschachtelungsebene der Aufgabe um eine Ebene nach unten, abhängig von der benachbarten Aufgabe
moveTask()Verschiebt eine Aufgabe an die angegebene Position
openInlineEditor()Öffnet den Inline-Editor einer Aufgabe/eines Projekts
parse()Lädt Daten in die To Do List
pasteTask()Fügt die kopierte Aufgabe aus der Zwischenablage an der angegebenen Position ein
redo()Wiederholt die Aktion, die durch die Undo-Aktion rückgängig gemacht wurde
selectTask()Wählt die angegebene Aufgabe anhand ihrer ID aus
serialize()Serialisiert die Daten der To Do List in ein JSON-Objekt
setConfig()Legt eine neue Konfiguration für die To Do List fest
setLocale()Legt das angegebene Gebietsschema für die To Do List fest
setFilter()Filtert Aufgaben nach den angegebenen Kriterien innerhalb eines aktiven Projekts
setProject()Legt das angegebene Projekt als aktives Projekt fest
setSort()Sortiert die Aufgaben des aktiven Projekts nach den angegebenen Parametern
showCompletedTasks()Schaltet die To Do List in den Modus, in dem abgeschlossene Aufgaben auf der Seite angezeigt werden
unassignUser()Hebt die Zuweisung einer Person von der angegebenen Aufgabe auf
uncheckTask()Markiert eine Aufgabe als unvollständig
undo()Macht die letzte Operation in der To Do List rückgängig
unindentTask()Hebt die Verschachtelungsebene der Aufgabe um eine Ebene an, abhängig von der benachbarten Aufgabe
unselectTask()Hebt die Auswahl einer oder mehrerer Aufgaben auf
updateProject()Aktualisiert die Konfigurationsparameter eines Projekts
updateTask()Aktualisiert die Konfigurationsparameter einer Aufgabe

Interne To-Do-List-API

Event-Bus-Methoden

NameBeschreibung
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 des DataStore der To Do List zurück
api.getState()Gibt ein Objekt mit den aktuellen Eigenschaften des DataStore der To Do List zurück
api.getStores()Gibt ein Objekt mit dem DataStore-Objekt der To Do List zurück

To-Do-List-Events

NameBeschreibung
add-projectWird ausgelöst, wenn ein neues Projekt hinzugefügt wird
add-taskWird ausgelöst, wenn eine neue Aufgabe hinzugefügt wird
assign-userWird ausgelöst, wenn einer Aufgabe ein Benutzer zugewiesen wird
check-taskWird ausgelöst, wenn eine Aufgabe als abgeschlossen markiert wird
clone-taskWird ausgelöst, wenn eine Aufgabe aus der Zwischenablage an der angegebenen Position eingefügt wird
close-inline-editorWird ausgelöst, wenn der Inline-Editor einer Aufgabe oder eines Projekts geschlossen wird
close-menuWird ausgelöst, wenn das Menü geschlossen wird
collapse-taskWird ausgelöst, wenn eine Aufgabe eingeklappt wird
copy-taskWird ausgelöst, wenn eine Aufgabe in die Zwischenablage kopiert wird
delete-projectWird ausgelöst, wenn ein Projekt entfernt wird
delete-taskWird ausgelöst, wenn eine Aufgabe entfernt wird
dragWird ausgelöst, wenn der Benutzer Aufgaben per Drag-and-Drop verschiebt
edit-itemWird ausgelöst, wenn der Wert einer Aufgabe/eines Projekts über den Inline-Editor bearbeitet wird
end-dragWird ausgelöst, wenn das Ziehen von Aufgaben abgeschlossen wurde
expand-taskWird ausgelöst, wenn eine Aufgabe aufgeklappt wird
hide-completed-tasksWird ausgelöst, wenn die To Do List in den Modus zum Ausblenden abgeschlossener Aufgaben wechselt
indent-taskWird ausgelöst, wenn die Verschachtelungsebene einer Aufgabe um eine Ebene tiefer gestuft wird
keypress-on-todoWird ausgelöst, wenn eine Aufgabe den Fokus hat und die Tastaturnavigation verwendet wird
move-taskWird ausgelöst, wenn eine Aufgabe verschoben wird
open-inline-editorWird ausgelöst, wenn der Inline-Editor einer Aufgabe oder eines Projekts geöffnet wird
open-menuWird ausgelöst, wenn das Menü geöffnet wird
paste-taskWird ausgelöst, wenn eine Aufgabe aus der Zwischenablage an der angegebenen Position eingefügt wird
select-taskWird ausgelöst, wenn eine Aufgabe ausgewählt wird
set-filterWird ausgelöst, wenn Daten nach den angegebenen Kriterien gefiltert werden
set-projectWird ausgelöst, wenn das aktive Projekt gewechselt wird
set-sortWird ausgelöst, wenn Aufgaben sortiert werden
show-completed-tasksWird ausgelöst, wenn die To Do List in den Modus zum Anzeigen erledigter Aufgaben umgeschaltet wird
start-dragWird ausgelöst, wenn der Benutzer beginnt, Aufgaben zu verschieben
unassign-userWird ausgelöst, wenn die Zuweisung eines Benutzers zu einer Aufgabe aufgehoben wird
uncheck-taskWird ausgelöst, wenn eine Aufgabe als nicht abgeschlossen markiert wird
unindent-taskWird ausgelöst, wenn die Verschachtelungsebene einer Aufgabe um eine Stufe angehoben wird
unselect-taskWird ausgelöst, wenn die Auswahl einer Aufgabe aufgehoben wird
update-projectWird ausgelöst, wenn ein Projekt aktualisiert wird
update-taskWird ausgelöst, wenn eine Aufgabe aktualisiert wird

To-Do-List-Eigenschaften

NameBeschreibung
activeProjectOptional. Die ID des aktiven Projekts
dragOptional. Legt die Einstellungen für Drag-and-Drop fest
historyOptional. Aktiviert/deaktiviert die Verwaltung des Änderungsverlaufs
idOptional. Die ID der To Do List
localeOptional. Wendet das erforderliche Gebietsschema auf die Komponente an
menuOptional. Gibt die Sichtbarkeit des Kontextmenüs (als Boolean) oder Konfigurationsparameter (als Funktion) an
prioritiesOptional. Gibt ein Array von Objekten mit den Prioritätsdaten an
projectsOptional. Legt ein Array von Projektobjekten fest, die in die Liste eingefügt werden
readonlyOptional. Versetzt die To Do List in den Nur-Lesen-Modus
selectedOptional. Ein Array mit den IDs der Aufgaben, die bei der Initialisierung der To Do List ausgewählt sein sollen
tagsOptional. Ein Array von Hashtags, die standardmäßig angezeigt werden
tasksOptional. Legt ein Array von Aufgabenobjekten fest, die in die Liste eingefügt werden
taskShapeOptional. Ein Objekt mit Einstellungen für die Darstellung von Aufgaben
usersOptional. Legt ein Array von Objekten fest, die die Benutzerdaten enthalten