formcycle 8.4.0 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle AppointmentPickerApiSelect

    Stellt Funktionen bereit, die sich auf das Abrufen von Daten aus einem Terminwähler beziehen, wie den ausgewählten Slot oder ob der Wähler geöffnet / geschlossen ist.

    Verfügbar über $.xutil.appointmentPicker.get.

    interface AppointmentPickerApiSelect {
        appointmentTemplate: (picker: any) => AppointmentTemplate;
        appointmentType: (picker: any) => AppointmentType;
        date: (picker: any) => LocalDate;
        disabledDates: (picker: any) => readonly LocalDateRange[];
        isDateDisabled: (picker: any, date: LocalDate) => boolean;
        isLocked: (picker: any) => boolean;
        isOpened: (picker: any) => boolean;
        lock: (picker: any) => AppointmentPickerLockState;
        monthYear: (picker: any) => LocalMonthYear;
        options: (picker: any) => AppointmentPickerOptions;
        persistedAppointment: (
            picker: any,
        ) => AppointmentPickerPersistedAppointment;
        slot: (picker: any) => AppointmentSlot;
        slotStartDate: (picker: any) => Date;
    }
    Index

    Eigenschaften

    appointmentTemplate: (picker: any) => AppointmentTemplate

    Ermittelt die Terminvorlage für den ersten Terminwähler anhand der angegebenen Referenz.

    Jeder Terminwähler ist mit einer Terminvorlage verknüpft, die im Backend konfiguriert werden kann.

    Typendeklaration

      • (picker: any): AppointmentTemplate
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, aus dem die Typ-UUID gelesen werden soll.

        Rückgabewert AppointmentTemplate

        Die Terminvorlage des Terminwählers.

    appointmentType: (picker: any) => AppointmentType

    Ermittelt die Terminvorlage für den ersten Terminwähler anhand der angegebenen Referenz.

    Jeder Terminwähler ist mit einer Terminvorlage verknüpft, die im Backend konfiguriert werden kann.

    Typendeklaration

      • (picker: any): AppointmentType
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, aus dem die Typ-UUID gelesen werden soll.

        Rückgabewert AppointmentType

        Die Terminvorlage des Terminwählers.

    date: (picker: any) => LocalDate

    Ermittelt das aktuell ausgewählte Datum des ersten Terminwählers anhand der angegebenen Referenz.

    Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

      • (picker: any): LocalDate
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, aus dem das ausgewählte Datum gelesen werden soll.

        Rückgabewert LocalDate

        Das aktuell ausgewählte Datum oder undefined, wenn kein Datum ausgewählt ist.

    disabledDates: (picker: any) => readonly LocalDateRange[]

    Gibt eine Liste aller deaktivierten Datumsbereiche zurück, für den ersten Terminwähler anhand der angegebenen Referenz.

    Deaktivierte Daten können vom Benutzer nicht ausgewählt werden. Beachten Sie, dass Daten ohne verfügbare Slots normalerweise auch als deaktiviert angezeigt werden, aber nicht in das Ergebnis dieser Funktion einbezogen werden.

    Typendeklaration

      • (picker: any): readonly LocalDateRange[]
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, der verarbeitet werden soll.

        Rückgabewert readonly LocalDateRange[]

        Eine Liste der deaktivierten Daten.

    isDateDisabled: (picker: any, date: LocalDate) => boolean

    Überprüft, ob das angegebene Datum für den ersten Terminwähler aus der angegebenen Referenz deaktiviert ist.

    Deaktivierte Daten können vom Benutzer nicht ausgewählt werden. Beachten Sie, dass Daten ohne verfügbare Slots normalerweise auch als deaktiviert angezeigt werden, aber nicht in das Ergebnis dieser Funktion einbezogen werden.

    Typendeklaration

      • (picker: any, date: LocalDate): boolean
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, der verarbeitet werden soll.

        • date: LocalDate

          Ein Datum, das überprüft werden soll.

        Rückgabewert boolean

        Ob das angegebene Datum deaktiviert ist.

    isLocked: (picker: any) => boolean

    Überprüft, ob der Terminwähler gesperrt ist, für den ersten Terminwähler aus der angegebenen Referenz.

    Der Terminwähler ist gesperrt, wenn er deaktiviert oder schreibgeschützt ist und nicht bearbeitet werden kann.

    Gibt false zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

      • (picker: any): boolean
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, für den überprüft werden soll, ob er gesperrt ist.

        Rückgabewert boolean

        true, wenn der Terminwähler gesperrt ist, oder false sonst.

    isOpened: (picker: any) => boolean

    Überprüft, ob der Terminwähler geöffnet oder geschlossen ist, für den ersten Terminwähler aus der angegebenen Referenz.

    Gibt false zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

      • (picker: any): boolean
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, für den überprüft werden soll, ob er geöffnet ist.

        Rückgabewert boolean

        true, wenn der Terminwähler geöffnet ist, oder false sonst. Gibt immer true zurück, wenn der Terminwähler nicht schließbar ist.

    lock: (picker: any) => AppointmentPickerLockState

    Ermittelt den Sperrzustand des Terminwählers für den ersten Terminwähler anhand der angegebenen Referenz.

    Der Terminwähler ist gesperrt, wenn er deaktiviert oder schreibgeschützt ist und nicht bearbeitet werden kann.

    Dies ist ähnlich wie isLocked, enthält jedoch Informationen darüber, ob der Terminwähler deaktiviert oder schreibgeschützt ist.

    Gibt enabled zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

    monthYear: (picker: any) => LocalMonthYear

    Ermittelt den aktuell angezeigten Monat im Kalender für den ersten Terminwähler anhand der angegebenen Referenz.

    Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

      • (picker: any): LocalMonthYear
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, aus dem der aktuell angezeigte Monat gelesen werden soll.

        Rückgabewert LocalMonthYear

        Der aktuell angezeigte Monat und das Jahr oder der aktuelle Monat und das Jahr, wenn die Referenz nicht auf Terminwähler verweist.

    options: (picker: any) => AppointmentPickerOptions

    Ruft die Optionen des ersten Terminwählers anhand der angegebenen Referenz ab.

    Gibt undefined zurück, wenn die angegebene Referenz nicht auf einen vorhandenen Terminwähler zeigt.

    Typendeklaration

    persistedAppointment: (picker: any) => AppointmentPickerPersistedAppointment

    Ruft den gespeicherten Termin, falls vorhanden, für den ersten Terminwähler aus der angegebenen Referenz ab.

    Jeder Terminwähler kann mit einem Termin verknüpft sein, der auf dem Server gebucht wurde, normalerweise zuvor, als das Formular zum ersten Mal übermittelt wurde. Normalerweise werden ausgewählte Slots, die nicht mit einem verfügbaren Slot übereinstimmen, als ungültig behandelt. Wenn ein ausgewählter Slot mit dem gespeicherten Slot übereinstimmt, ist diese Auswahl immer zulässig.

    Typendeklaration

    slot: (picker: any) => AppointmentSlot

    Ruft den aktuell ausgewählten Slot des ersten Terminwählers anhand der angegebenen Referenz ab.

    Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

      • (picker: any): AppointmentSlot
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, aus dem der ausgewählte Slot abgerufen werden soll.

        Rückgabewert AppointmentSlot

        Der aktuell ausgewählte Slot oder undefined, wenn kein Slot ausgewählt ist.

    slotStartDate: (picker: any) => Date

    Ruft das Startdatum des aktuell ausgewählten Slots des ersten Terminwählers aus der angegebenen Referenz ab. Das Ergebnis wird als JavaScript-Datumsobjekt zurückgegeben.

    Gibt undefined zurück, wenn die angegebene Picker-Instanzreferenz nicht auf eine vorhandene Terminwähler-Instanz verweist.

    Typendeklaration

      • (picker: any): Date
      • Parameter

        • picker: any

          Eine Referenz auf den Terminwähler, aus dem der ausgewählte Slot abgerufen werden soll.

        Rückgabewert Date

        Das Startdatum des aktuell ausgewählten Slots oder undefined, wenn kein Slot ausgewählt ist.