Interface DateTimePickerOptions

Hierarchy

Index

Properties

Properties

optional public addSliderAccess?: boolean

optional public altField?: any

An input element that is to be updated with the selected date from the datepicker. Use the altFormat option to change the format of the date within this field. Leave as blank for no alternate field.

optional public altFieldTimeOnly?: boolean

optional public altFormat?: string

The dateFormat to be used for the altField option. This allows one date format to be shown to the user for selection purposes, while a different format is actually sent behind the scenes. For a full list of the possible formats see the formatDate function

optional public altSeparator?: string

optional public altTimeFormat?: string

optional public altTimeSuffix?: string

optional public alwaysSetTime?: boolean

optional public amNames?: string

optional public appendText?: string

The text to display after each date field, e.g., to show the required format.

optional public autoSize?: boolean

Set to true to automatically resize the input field to accommodate dates in the current dateFormat.

optional public beforeShow?: (input: Element, inst: any) => JQueryUI.DatepickerOptions

A function that takes an input field and current datepicker instance and returns an options object to update the datepicker with. It is called just before the datepicker is displayed.

optional public beforeShowDay?: (date: Date) => any[]

A function that takes a date as a parameter and must return an array with: [0]: true/false indicating whether or not this date is selectable [1]: a CSS class name to add to the date's cell or "" for the default presentation [2]: an optional popup tooltip for this date The function is called for each day in the datepicker before it is displayed.

optional public buttonImage?: string

A URL of an image to use to display the datepicker when the showOn option is set to "button" or "both". If set, the buttonText option becomes the alt value and is not directly displayed.

optional public buttonImageOnly?: boolean

Whether the button image should be rendered by itself instead of inside a button element. This option is only relevant if the buttonImage option has also been set.

optional public buttonText?: string

The text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "both".

optional public calculateWeek?: (date: Date) => string

A function to calculate the week of the year for a given date. The default implementation uses the ISO 8601 definition: weeks start on a Monday; the first week of the year contains the first Thursday of the year.

optional public changeMonth?: boolean

Whether the month should be rendered as a dropdown instead of text.

optional public changeYear?: boolean

Whether the year should be rendered as a dropdown instead of text. Use the yearRange option to control which years are made available for selection.

optional public closeText?: string

The text to display for the close link. Use the showButtonPanel option to display this button.

optional public constrainInput?: boolean

When true, entry in the input field is constrained to those characters allowed by the current dateFormat option.

optional public controlType?: string

optional public currentText?: string

The text to display for the current day link. Use the showButtonPanel option to display this button.

optional public dateFormat?: string

The format for parsed and displayed dates. For a full list of the possible formats see the formatDate function.

optional public dayNames?: Array<string>

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

optional public dayNamesMin?: Array<string>

The list of minimised day names, starting from Sunday, for use as column headers within the datepicker.

optional public dayNamesShort?: Array<string>

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

optional public defaultDate?: any

Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object or as a string in the current dateFormat, or a number of days from today (e.g. +7) or a string of values and periods ('y' for years, 'm' for months, 'w' for weeks, 'd' for days, e.g. '+1m +7d'), or null for today. Multiple types supported: Date: A date object containing the default date. Number: A number of days from today. For example 2 represents two days from today and -1 represents yesterday. String: A string in the format defined by the dateFormat option, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.

optional public defaultValue?: string

optional public duration?: string

Control the speed at which the datepicker appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast").

optional public firstDay?: number

Set the first day of the week: Sunday is 0, Monday is 1, etc.

optional public gotoCurrent?: boolean

When true, the current day link moves to the currently selected date instead of today.

optional public hideIfNoPrevNext?: boolean

Normally the previous and next links are disabled when not applicable (see the minDate and maxDate options). You can hide them altogether by setting this attribute to true.

optional public hour?: number

optional public hourGrid?: number

optional public hourMax?: number

optional public hourMin?: number

optional public hourText?: string

optional public isRTL?: boolean

Whether the current language is drawn from right to left.

optional public maxDate?: any

The maximum selectable date. When set to null, there is no maximum. Multiple types supported: Date: A date object containing the maximum date. Number: A number of days from today. For example 2 represents two days from today and -1 represents yesterday. String: A string in the format defined by the dateFormat option, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.

optional public maxDateTime?: Date

optional public microsec?: number

optional public microsecGrid?: number

optional public microsecMax?: number

optional public microsecMin?: number

optional public microsecText?: string

optional public millisec?: number

optional public millisecGrid?: number

optional public millisecMax?: number

optional public millisecMin?: number

optional public millisecText?: string

optional public minDate?: any

The minimum selectable date. When set to null, there is no minimum. Multiple types supported: Date: A date object containing the minimum date. Number: A number of days from today. For example 2 represents two days from today and -1 represents yesterday. String: A string in the format defined by the dateFormat option, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.

optional public minDateTime?: Date

optional public minute?: number

optional public minuteGrid?: number

optional public minuteMax?: number

optional public minuteMin?: number

optional public minuteText?: string

optional public monthNames?: Array<string>

The list of full month names, for use as requested via the dateFormat option.

optional public monthNamesShort?: Array<string>

The list of abbreviated month names, as used in the month header on each datepicker and as requested via the dateFormat option.

optional public navigationAsDateFormat?: boolean

Whether the prevText and nextText options should be parsed as dates by the formatDate function, allowing them to display the target month names for example.

optional public nextText?: string

The text to display for the next month link. With the standard ThemeRoller styling, this value is replaced by an icon.

optional public numberOfMonths?: any

The number of months to show at once. Multiple types supported: Number: The number of months to display in a single row. Array: An array defining the number of rows and columns to display.

optional public onChangeMonthYear?: (year: number, month: number, inst: any) => void

Called when the datepicker moves to a new month and/or year. The function receives the selected year, month (1-12), and the datepicker instance as parameters. this refers to the associated input field.

optional public onClose?: (dateText: string, inst: any) => void

Called when the datepicker is closed, whether or not a date is selected. The function receives the selected date as text ("" if none) and the datepicker instance as parameters. this refers to the associated input field.

optional public onSelect?: () => any

Called when the datepicker is selected. The function receives the selected date as text and the datepicker instance as parameters. this refers to the associated input field.

optional public parse?: string

optional public pickerTimeFormat?: string

optional public pickerTimeSuffix?: string

optional public pmNames?: string

optional public prevText?: string

The text to display for the previous month link. With the standard ThemeRoller styling, this value is replaced by an icon.

optional public second?: number

optional public secondGrid?: number

optional public secondMax?: number

optional public secondMin?: number

optional public secondText?: string

optional public selectOtherMonths?: boolean

Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true.

optional public separator?: string

optional public shortYearCutoff?: any

The cutoff year for determining the century for a date (used in conjunction with dateFormat 'y'). Any dates entered with a year value less than or equal to the cutoff year are considered to be in the current century, while those greater than it are deemed to be in the previous century. Multiple types supported: Number: A value between 0 and 99 indicating the cutoff year. String: A relative number of years from the current year, e.g., "+3" or "-5".

optional public showAnim?: string

The name of the animation used to show and hide the datepicker. Use "show" (the default), "slideDown", "fadeIn", any of the jQuery UI effects. Set to an empty string to disable animation.

optional public showButtonPanel?: boolean

Whether to display a button pane underneath the calendar. The button pane contains two buttons, a Today button that links to the current day, and a Done button that closes the datepicker. The buttons' text can be customized using the currentText and closeText options respectively.

optional public showCurrentAtPos?: number

When displaying multiple months via the numberOfMonths option, the showCurrentAtPos option defines which position to display the current month in.

optional public showHour?: boolean

optional public showMicrosec?: boolean

optional public showMillisec?: boolean

optional public showMinute?: boolean

optional public showMonthAfterYear?: boolean

Whether to show the month after the year in the header.

optional public showOn?: string

When the datepicker should appear. The datepicker can appear when the field receives focus ("focus"), when a button is clicked ("button"), or when either event occurs ("both").

optional public showOptions?: any

If using one of the jQuery UI effects for the showAnim option, you can provide additional settings for that animation via this option.

optional public showOtherMonths?: boolean

Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option.

optional public showSecond?: boolean

optional public showTime?: boolean

optional public showTimepicker?: boolean

optional public showTimezone?: boolean

optional public showWeek?: boolean

When true, a column is added to show the week of the year. The calculateWeek option determines how the week of the year is calculated. You may also want to change the firstDay option.

optional public sliderAccessArgs?: any

optional public stepHour?: number

optional public stepMicrosec?: number

optional public stepMillisec?: number

optional public stepMinute?: number

optional public stepMonths?: number

Set how many months to move when clicking the previous/next links.

optional public stepSecond?: number

optional public timeFormat?: string

optional public timeOnly?: boolean

optional public timeOnlyTitle?: string

optional public timeSuffix?: string

optional public timeText?: string

optional public timezone?: number

optional public timezoneList?: TimezoneOptions[]

optional public timezoneText?: string

optional public weekHeader?: string

The text to display for the week of the year column heading. Use the showWeek option to display this column.

optional public yearRange?: string

The range of years displayed in the year drop-down: either relative to today's year ("-nn:+nn"), relative to the currently selected year ("c-nn:c+nn"), absolute ("nnnn:nnnn"), or combinations of these formats ("nnnn:-nn"). Note that this option only affects what appears in the drop-down, to restrict which dates may be selected use the minDate and/or maxDate options.

optional public yearSuffix?: string

Additional text to display after the year in the month headers.