formcycle 8.3.6 - JavaScript for forms
    Preparing search index...

    Interface AppointmentPickerOptionsInitOptions

    Options when initializing the appointment picker. Contains all runtime options plus some more settings available only during initialization.

    interface AppointmentPickerOptionsInitOptions {
        closable: boolean;
        dateFormat: string;
        dateTimeFormat: string;
        dayNames: readonly string[];
        dayNamesMin: readonly string[];
        dayNamesShort: readonly string[];
        firstDayOfWeek: number;
        monthNames: readonly string[];
        monthNamesShort: readonly string[];
        showCapacity: boolean;
        showClearSlotButton: boolean;
        showEndTime: boolean;
        textAvailableCapacity: string;
        textClosePicker: string;
        textNextMonth: string;
        textNoAvailableSlots: string;
        textNoneSelected: string;
        textNoSlotSelected: string;
        textOpenPicker: string;
        textPrevMonth: string;
        textSlotAtDisabledDate: string;
        textTimeZone: string;
        textUnavailableSlot: string;
        textUnselectSlot: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    closable dateFormat dateTimeFormat dayNames dayNamesMin dayNamesShort firstDayOfWeek monthNames monthNamesShort showCapacity showClearSlotButton showEndTime textAvailableCapacity textClosePicker textNextMonth textNoAvailableSlots textNoneSelected textNoSlotSelected textOpenPicker textPrevMonth textSlotAtDisabledDate textTimeZone textUnavailableSlot textUnselectSlot

    Properties

    closable: boolean

    Whether the appointment picker can be closed.

    Regarding displayMode:

    • When displayMode = disabled / read-only, a single input with the currently selected slot (if any) is shown; regardless of closable.
    • When closable = false and displayMode = open / "close", the picker is always shown.
    • When closable = true and displayMode = open, the picker with the calendar is shown.
    • When closable = true and displayMode = close, a single input with the currently selected slot (if any) is shown.
    dateFormat: string

    The date format to use for displaying dates. Currently, this is the format as used by JQueryUI datepicker.

    dateTimeFormat: string

    The date time format to use for displaying a date with a time. Use %1 for the date and %2 for the time.

    dayNames: readonly string[]

    The list of long day names, starting from Sunday, for use as requested via the dateFormat option.

    dayNamesMin: readonly string[]

    The list of very short day names, starting from Sunday, for use as column headers within the appointment picker.

    dayNamesShort: readonly string[]

    The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat option.

    firstDayOfWeek: number

    The day at which a week should be considered to start. This affects e.g. the columns of the calendar.

    monthNames: readonly string[]

    The list of month names, starting from January, for use as requested via the dateFormat option.

    monthNamesShort: readonly string[]

    The list of abbreviated month names, starting from January, for use as requested via the dateFormat option.

    showCapacity: boolean

    Whether to show the capacity for each slot as well, in addition to the start time.

    showClearSlotButton: boolean

    Whether to show the button to clear the selected slot.

    showEndTime: boolean

    Whether to show the end time for each slot as well, in addition to the start time.

    textAvailableCapacity: string

    The text to use for indicating the capacity of a slot. Use the placeholder %1 to insert the capacity.

    textClosePicker: string

    Text to show for the button to close the appointment picker (only when the picker is opened).

    textNextMonth: string

    The text for the button to switch to the next month.

    textNoAvailableSlots: string

    The text to show when the selected date has no available free slots. Use the placeholder `%1 to insert the date.

    textNoneSelected: string

    The text to show when the picker is closed and no appointment is selected.

    textNoSlotSelected: string

    The text to show when no slot is selected (when a slot is selected, the date and time is shown).

    textOpenPicker: string

    Text to show for the button to open the appointment picker (only when the picker is closed).

    textPrevMonth: string

    The text for the button to switch to the previous month.

    textSlotAtDisabledDate: string

    The text to use when a slot is selected that is not available.

    textTimeZone: string

    The text for the header that indicates the time zone.

    textUnavailableSlot: string

    The text to use when a slot is selected that is not available.

    textUnselectSlot: string

    The text to show for the button to unselect the selected slot.

    Settings

    Member Visibility

    On This Page

    Properties