API-Übersicht
Booking-Konstruktor
new booking.Booking("#root", {
// initiale Konfigurationsparameter
});
Parameter:
- ein HTML-Container oder dessen ID-Selektor (
HTMLElement | string) - ein Objekt der Konfigurationsparameter (hier nachschlagen)
Booking-Methoden
| Name | Beschreibung |
|---|---|
| serialize() | Serialisiert Booking-Daten in ein JSON-Array |
| setConfig() | Aktualisiert die aktuelle Konfiguration des Booking-Widgets |
| setConfirmHandler() | Registriert einen Handler für das confirm-slot-Event |
| setLocale() | Wendet eine neue Locale auf Booking an |
Internes Booking-API
Event-Bus-Methoden
| Name | Beschreibung |
|---|---|
| api.detach() | Ermöglicht das Entfernen/Abkoppeln von Event-Handlern |
| api.exec() | Ermöglicht das Auslösen der internen Events |
| api.intercept() | Ermöglicht das Abfangen und Verhindern von internen Events |
| api.on() | Ermöglicht das Anhängen eines Handlers an interne Events |
| api.setNext() | Fügt einen benutzerdefinierten Handler am Ende der Event-Bus-Kette des Widgets hinzu |
State-Methoden
| Name | Beschreibung |
|---|---|
| api.getReactiveState() | Gibt ein Objekt mit den reaktiven Eigenschaften von Booking zurück |
| api.getState() | Gibt ein Objekt mit den StateStore-Eigenschaften von Booking zurück |
Booking-Events
| Name | Beschreibung |
|---|---|
| confirm-slot | Wird ausgelöst, wenn die Buchung eines Slots bestätigt wird |
| filter-data | Wird ausgelöst, wenn Filter angewendet werden |
| select-item | Wird ausgelöst, wenn ein Element ausgewählt wird |
| select-item-date | Wird ausgelöst, wenn ein Datum für ein Element ausgewählt wird |
| select-slot | Wird ausgelöst, wenn ein Slot ausgewählt wird |
Booking-Eigenschaften
| Name | Beschreibung |
|---|---|
| data | Optional. Ein Array von Objekten, das die Kartendaten enthält |
| end | Optional. Legt das Datum fest, bis zu dem verfügbare Slots angezeigt werden |
| cardShape | Optional. Ein Objekt mit Einstellungen zur Verwaltung der auf der linken Seite jeder Karte angezeigten Informationen |
| cardTemplate | Optional. Ermöglicht das Anwenden einer Vorlage auf den linken Block einer Karte |
| filterShape | Optional. Ein Objekt mit Einstellungen zur Steuerung der Filter-Funktionalität |
| formShape | Optional. Ein Array von Objekten mit Einstellungen zur Konfiguration der Felder im Booking-Dialog |
| infoShape | Optional. Ein Objekt mit Einstellungen zur Steuerung der Informationen, die auf der linken Seite des Booking-Dialogs angezeigt werden |
| infoTemplate | Optional. Ermöglicht das Anwenden einer Vorlage auf den Informationsblock im Booking-Dialog |
| locale | Optional. Ein Objekt mit einer benutzerdefinierten Locale für Booking |
| renderType | Optional. Legt fest, wie Karten gerendert werden |
| slotGap | Optional. Legt einen Abstand zwischen Buchungsslots für alle Karten fest |
| slotSize | Optional. Definiert die Dauer eines Buchungs-Slots für alle Karten |
| start | Optional. Legt das Datum fest, ab dem verfügbare Zeitfenster angezeigt werden |