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.
Default: true - When altField is used from datepicker, altField will only receive the formatted time
and the original field only receives date.
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
Default: true - Whether to immediately focus the main field whenever the altField receives focus. Effective at construction time only, changing it later has no effect.
Default: (separator option) - String placed between formatted date and formatted time in the altField.
Default: (timeFormat option) - The time format to use with the altField.
Default: (timeSuffix option) - String always placed after the formatted time in the altField.
Default: true - Always have a time set internally, even before user has chosen one.
Default: ["AM", "A"], A Localization Setting - Array of strings to try and parse against to determine AM.
The text to display after each date field, e.g., to show the required format.
Set to true to automatically resize the input field to accommodate dates in the current dateFormat.
Set to true to automatically hide the datepicker.
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.
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.
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.
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.
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.
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.
The text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "both".
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.
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.
Whether the month should be rendered as a dropdown instead of text.
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.
The text to display for the close link. Use the showButtonPanel option to display this button.
When true, entry in the input field is constrained to those characters allowed by the current dateFormat option.
Default: slider - How to select a time (hour / minute / second). If slider is unavailable through
jQueryUI, select will be used. For advanced usage you may set this to a custom control to use controls
other than sliders or selects.
The text to display for the current day link. Use the showButtonPanel option to display this button.
The format for parsed and displayed dates. For a full list of the possible formats see the formatDate function.
The list of long day names, starting from Sunday, for use as requested via the dateFormat option.
The list of minimised day names, starting from Sunday, for use as column headers within the datepicker.
The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat option.
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.
Default: null - String of the default time value placed in the input on focus when the input is empty.
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").
Set to date to automatically enddate the datepicker.
Set the first day of the week: Sunday is 0, Monday is 1, etc.
When true, the current day link moves to the currently selected date instead of today.
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.
Default: 0 - Initial hour set.
Default: 0 - When greater than 0 a label grid will be generated under the slider. This number represents
the units (in hours) between labels.
Default: 23 - The maximum hour allowed for all dates.
Default: 0 - The minimum hour allowed for all dates.
Default: Hour, A Localization Setting - Label used to identify the hour slider.
Whether the current language is drawn from right to left.
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.
Default: null - Date object of the maximum datetime allowed. Also Available as maxDate.
Default: null - String of the maximum time allowed. '8:00 pm' will restrict to times before 8pm
Default: 0 - Initial microsecond set. Note: Javascript's native Date object does not natively support
microseconds. Timepicker extends the Date object with Date.prototype.setMicroseconds(m) and
Date.prototype.getMicroseconds(). Date comparisons will not acknowledge microseconds. Use this only for
display purposes.
Default: 0 - When greater than 0 a label grid will be genereated under the slider. This number represents
the units (in microseconds) between labels.
Default: 999 - The maximum microsecond allowed for all dates.
Default: 0 - The minimum microsecond allowed for all dates.
Default: Microsecond, A Localization Setting - Label used to identify the microsecond slider.
Default: 0 - Initial millisecond set.
Default: 0 - When greater than 0 a label grid will be genereated under the slider. This number represents
the units (in milliseconds) between labels.
Default: 999 - The maximum millisecond allowed for all dates.
Default: 0 - The minimum millisecond allowed for all dates.
Default: Millisecond, A Localization Setting - Label used to identify the millisecond slider.
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.
Default: null - Date object of the minimum datetime allowed. Also available as minDate.
Default: null - String of the minimum time allowed. '8:00 am' will restrict to times after 8am
Default: 0 - Initial minute set.
Default: 0 - When greater than 0 a label grid will be generated under the slider. This number represents
the units (in minutes) between labels.
Default: 59 - The maximum minute allowed for all dates.
Default: 0 - The minimum minute allowed for all dates.
Default: Minute, A Localization Setting - Label used to identify the minute slider.
The list of full month names, for use as requested via the dateFormat option.
The list of abbreviated month names, as used in the month header on each datepicker and as requested via the dateFormat option.
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.
The text to display for the next month link. With the standard ThemeRoller styling, this value is replaced by an icon.
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.
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.
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.
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.
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.
Default: false - Try to show the time dropdowns all on one line. This should be used with controlType
select and as few units as possible.
Default: strict - How to parse the time string. You may also set this to a function to handle the parsing
yourself.
Default: (timeFormat option) - How to format the time displayed within the timepicker.
Default: (timeSuffix option) - String to place after the formatted time within the timepicker.
Default: ["PM", "P"], A Localization Setting - Array of strings to try and parse against to determine PM.
The text to display for the previous month link. With the standard ThemeRoller styling, this value is replaced by an icon.
Default: 0 - Initial second set.
Default: 0 - When greater than 0 a label grid will be genereated under the slider. This number represents
the units (in seconds) between labels.
Default: 59 - The maximum second allowed for all dates.
Default: 0 - The minimum second allowed for all dates.
Default: Second, A Localization Setting - Label used to identify the second slider.
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.
Default: space ( ) - When formatting the time this string is placed between the formatted date and
formatted time.
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".
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.
Default: true - Whether to show the button panel at the bottom. This is generally needed.
When displaying multiple months via the numberOfMonths option, the showCurrentAtPos option defines which position to display the current month in.
Default: null - Whether to show the hour control. The default of null will use detection from timeFormat.
Default: null - Whether to show the microsecond control. The default of null will use detection from
timeFormat.
Default: null - Whether to show the millisecond control. The default of null will use detection from
timeFormat.
Default: null - Whether to show the minute control. The default of null will use detection from
timeFormat.
Whether to show the month after the year in the header.
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").
If using one of the jQuery UI effects for the showAnim option, you can provide additional settings for that animation via this option.
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.
Default: null - Whether to show the second control. The default of null will use detection from
timeFormat.
Default: true - Whether to show the time selected within the datetimepicker.
Default: true - Whether to show the timepicker within the datepicker.
Default: null - Whether to show the timezone select.
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.
Default: 1 - Hours per step the slider makes.
Default: 1 - Microseconds per step the slider makes.
Default: 1 - Milliseconds per step the slider makes.
Default: 1 - Minutes per step the slider makes.
Set how many months to move when clicking the previous/next links.
Default: 1 - Seconds per step the slider makes.
Default: HH:mm, A Localization Setting - String of format tokens to be replaced with the time.
Default: false - Allows direct input in time field
Default: false - Hide the datepicker and only provide a time interface.
Default: false - Show the date and time in the input, but only allow the timepicker.
Default: Choose Time, A Localization Setting - Title of the wigit when using only timepicker.
Default: Empty string, A Localization Setting - String to place after the formatted time.
Default: Time, A Localization Setting - Label used within timepicker for the formatted time.
Default: null - Initial timezone set. If null, the browser's local timezone will be used.
Default: [generated timezones] - An array of timezones used to populate the timezone select.
Default: Timezone, A Localization Setting - Label used to identify the timezone slider.
The text to display for the week of the year column heading. Use the showWeek option to display this column.
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.
Additional text to display after the year in the month headers.
Default: unset - Function to be called when the timepicker or selection control is injected or re-rendered.
Default: unset - Function to be called when a date is chosen or time has changed.
Currently selected date as text.
The current timepicker instance.
Generated using TypeDoc
Options for the date time picker that lets the user select a time.