Zum Hauptinhalt springen

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

NameBeschreibung
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

NameBeschreibung
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

NameBeschreibung
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

NameBeschreibung
confirm-slotWird ausgelöst, wenn die Buchung eines Slots bestätigt wird
filter-dataWird ausgelöst, wenn Filter angewendet werden
select-itemWird ausgelöst, wenn ein Element ausgewählt wird
select-item-dateWird ausgelöst, wenn ein Datum für ein Element ausgewählt wird
select-slotWird ausgelöst, wenn ein Slot ausgewählt wird

Booking-Eigenschaften

NameBeschreibung
dataOptional. Ein Array von Objekten, das die Kartendaten enthält
endOptional. Legt das Datum fest, bis zu dem verfügbare Slots angezeigt werden
cardShapeOptional. Ein Objekt mit Einstellungen zur Verwaltung der auf der linken Seite jeder Karte angezeigten Informationen
cardTemplateOptional. Ermöglicht das Anwenden einer Vorlage auf den linken Block einer Karte
filterShapeOptional. Ein Objekt mit Einstellungen zur Steuerung der Filter-Funktionalität
formShapeOptional. Ein Array von Objekten mit Einstellungen zur Konfiguration der Felder im Booking-Dialog
infoShapeOptional. Ein Objekt mit Einstellungen zur Steuerung der Informationen, die auf der linken Seite des Booking-Dialogs angezeigt werden
infoTemplateOptional. Ermöglicht das Anwenden einer Vorlage auf den Informationsblock im Booking-Dialog
localeOptional. Ein Objekt mit einer benutzerdefinierten Locale für Booking
renderTypeOptional. Legt fest, wie Karten gerendert werden
slotGapOptional. Legt einen Abstand zwischen Buchungsslots für alle Karten fest
slotSizeOptional. Definiert die Dauer eines Buchungs-Slots für alle Karten
startOptional. Legt das Datum fest, ab dem verfügbare Zeitfenster angezeigt werden