Interface AppointmentPickerApiSelect

Provides functions related to getting data from an appointment picker, such as the selected slot or whether the picker is opened / closed.

Available via $.xutil.appointmentPicker.get.

Hierarchy

  • AppointmentPickerApiSelect

Index

Properties

Properties

appointmentTemplate

appointmentTemplate: function

Finds the appointment template for first appointment picker from the given reference.

Each appointment picker is associated with an appointment template that can be configured in the backend.

param

A reference to the appointment picker from which to read the type UUID.

returns

The picker's appointment type UUID.

Type declaration

appointmentType

appointmentType: function

Finds the appointment template for first appointment picker from the given reference.

Each appointment may have multiple appointment types. Each type defines a schedule when appointments can be booked.

param

A reference to the appointment picker from which to read the type UUID.

returns

The picker's appointment type UUID.

Type declaration

date

date: function

Finds the currently selected date of the first appointment picker from the given reference.

Returns undefined when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker from which to get the selected date.

returns

The currently selected date, or undefined when no date is selected.

Type declaration

disabledDates

disabledDates: function

Gets a list of all disabled date ranges, for the first appointment picker from the given reference.

Disabled dates cannot be selected by the user. Note that dates without available slots are usually also displayed as disabled, but are not included in the result of this function.

param

A reference to the appointment picker to process.

param

Ranges of dates to enable.

returns

A list of disabled dates.

Type declaration

isDateDisabled

isDateDisabled: function

Checks whether the given date is disabled for the first appointment picker from the given reference.

Disabled dates cannot be selected by the user. Note that dates without available slots are usually also displayed as disabled, but are not included in the result of this function.

param

A reference to the appointment picker to process.

param

A date to check.

returns

Whether the given date is disabled.

Type declaration

isLocked

isLocked: function

Checks whether the appointment picker is locked, for the first appointment picker from the given reference.

The picker is locked when it is disabled or read-only and cannot be edited.

Returns false when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker for which to check whether it is locked.

returns

true when the picker is locked, or false otherwise.

Type declaration

isOpened

isOpened: function

Checks whether the appointment picker is opened or closed, for the first appointment picker from the given reference

Returns false when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker for which to check whether it is open.

returns

true when the picker is open, or false otherwise. Always returns true when the picker is not closable.

Type declaration

lock

lock: function

Gets the lock state of the appointment picker, for the first appointment picker from the given reference.

The picker is locked when it is disabled or read-only and cannot be edited.

This is similar to isLocked, but contains info about whether the picker is disabled or read-only.

Returns enabled when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker for which to get the lock mode.

returns

The lock state of the picker.

Type declaration

monthYear

monthYear: function

Finds the month currently viewed in the calendar for the first appointment picker from the given reference.

Returns undefined when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker from which to get the currently viewed month.

returns

The currently viewed month and year, or the current month and year when the reference does not solve to any appointment pickers.

Type declaration

options

options: function

Gets the options of the first appointment picker from the given reference.

Returns undefined when the the given reference does not point to an existing appointment picker.

param

A reference to the appointment picker from which to get the options.

returns

Options of the appointment picker.

Type declaration

persistedAppointment

persistedAppointment: function

Gets the persisted appointment, if any, for the first appointment picker from the given reference.

Each picker may be associated with an appointment that was booked on the server, usually previously when the form was first submitted. Normally selected slots that do not correspond to an available slot are treated as invalid. When a selected slot correspond to the persisted slot, that selection is always allowed. that corresponds to this persisted appointment

param

A reference to the appointment picker for which to get the persisted slot.

returns

The persisted slot, or undefined if no such slot exists.

Type declaration

slot

slot: function

Retrieves the currently selected slot of the first appointment picker from the given reference.

Returns undefined when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker from which to get the selected slot.

returns

The currently selected slot, or undefined when no slot is selected.

Type declaration

slotStartDate

slotStartDate: function

Retrieves the start date of the currently selected slot of the first appointment picker from the given reference. The result is returned as a JavaScript date object.

Returns undefined when the given picker instance reference does not resolve to any existing appointment picker instance.

param

A reference to the appointment picker from which to get the selected slot.

returns

The start date of the currently selected slot, or undefined when no slot is selected.

Type declaration