The main function of the key filter plugin that can be called on an input field to set up the key filter. Also contains some default and global configuration for the key filter.
The number of elements in the jQuery object.
The main function of the TouchSwipe plugin
Also contains some constants and the default settings.
Create a new jQuery object with elements added to the set of matched elements.
A string representing a selector expression to find additional elements to add to the set of matched elements.
The point in the document at which the selector should begin matching; similar to the context argument of the $(selector, context) method.
Create a new jQuery object with elements added to the set of matched elements.
@param selector_elements_html_selection
selector — A string representing a selector expression to find additional elements to add to the set of matched elements. elements — One or more elements to add to the set of matched elements. html — An HTML fragment to add to the set of matched elements. selection — An existing jQuery object to add to the set of matched elements.Add the previous set of elements on the stack to the current set, optionally filtered by a selector.
A string containing a selector expression to match the current set of elements against.
Adds the specified class(es) to each element in the set of matched elements.
@param className_function
className — One or more space-separated classes to be added to the class attribute of each matched element. function — A function returning one or more space-separated class names to be added to the existing class
name(s). Receives the index position of the element in the set and the existing class name(s) as
arguments. Within the function, this refers to the current element in the set.Insert content, specified by the parameter, after each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or jQuery objects to insert after each element in the set of matched elements.
Insert content, specified by the parameter, after each element in the set of matched elements.
@param function_functionｰhtml
function — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert
after each element in the set of matched elements. Receives the index position of the element in the
set as an argument. Within the function, this refers to the current element in the set. functionｰhtml — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert
after each element in the set of matched elements. Receives the index position of the element in the
set and the old HTML value of the element as arguments. Within the function, this refers to the
current element in the set.Register a handler to be called when Ajax requests complete. This is an AjaxEvent.
The function to be invoked.
Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.
The function to be invoked.
Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.
The function to be invoked.
Register a handler to be called when the first Ajax request begins. This is an Ajax Event.
The function to be invoked.
Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.
The function to be invoked.
Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.
The function to be invoked.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A map of additional options to pass to the method.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A function to call once the animation is complete, called once per matched element.
Insert content, specified by the parameter, to the end of each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or jQuery objects to insert at the end of each element in the set of matched elements.
Insert content, specified by the parameter, to the end of each element in the set of matched elements.
A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert at
the end of each element in the set of matched elements. Receives the index position of the element
in the set and the old HTML value of the element as arguments. Within the function, this refers to
the current element in the set.
Insert every element in the set of matched elements to the end of the target.
A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter.
Set one or more attributes for the set of matched elements.
The name of the attribute to set.
@param value_function
value — A value to set for the attribute. If null, the specified attribute will be removed (as in `.removeAttr()`). function — A function returning the value to set. this is the current element. Receives the index position of
the element in the set and the old attribute value as arguments.Set one or more attributes for the set of matched elements.
An object of attribute-value pairs to set.
Get the value of an attribute for the first element in the set of matched elements.
The name of the attribute to get.
Insert content, specified by the parameter, before each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or jQuery objects to insert before each element in the set of matched elements.
Insert content, specified by the parameter, before each element in the set of matched elements.
@param function_functionｰhtml
function — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert
before each element in the set of matched elements. Receives the index position of the element in
the set as an argument. Within the function, this refers to the current element in the set. functionｰhtml — A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert
before each element in the set of matched elements. Receives the index position of the element in
the set and the old HTML value of the element as arguments. Within the function, this refers to the
current element in the set.Attach a handler to an event for the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Attach a handler to an event for the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
@param handler_preventBubble
handler — A function to execute each time the event is triggered. preventBubble — Setting the third argument to false will attach a function that prevents the default action from
occurring and stops the event from bubbling. The default is true.Attach a handler to an event for the elements.
An object containing one or more DOM event types and functions to execute for them.
Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "change" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "change" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Get the children of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Remove from the queue all items that have not yet been run.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Bind an event handler to the "click" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "click" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Create a deep copy of the set of matched elements.
A Boolean indicating whether event handlers and data should be copied along with the elements. The default value is false. *In jQuery 1.5.0 the default value was incorrectly true; it was changed back to false in 1.5.1 and up.
A Boolean indicating whether event handlers and data for all children of the cloned element should be copied. By default its value matches the first argument's value (which defaults to false).
Copies all CSS style properties from this element to the target element
Target element to which to copy the CSS style properties.
Copies the given CSS style property from this element to the target element.
Target element to which to copy the style.
Name of the CSS style property.
For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
A string containing a selector expression to match elements against.
A DOM element within which a matching element may be found.
For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
@param selector_selection_element
selector — A string containing a selector expression to match elements against. selection — A jQuery object to match elements against. element — An element to match elements against.Unselects all selected text of an INPUT or TEXTAREA element.
this for chaining.
Get the children of each element in the set of matched elements, including text and comment nodes.
Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Creates a new image Cropper on the current elements.
this jQuery instance for chaining.
Invokes a method on the Cropper instance and returns the result.
Name of a method that exists on the Cropper instance.
Name of a method that exists on the Cropper instance.
Arguments required by the given cropper method.
The value as it returned by the cropper instance method.
Set one or more CSS properties for the set of matched elements.
A CSS property name.
@param value_function
value — A value to set for the property. function — A function returning the value to set. this is the current element. Receives the index position of
the element in the set and the old value as arguments.Set one or more CSS properties for the set of matched elements.
An object of property-value pairs to set.
Get the computed style properties for the first element in the set of matched elements.
A CSS property.
Get the computed style properties for the first element in the set of matched elements.
An array of one or more CSS properties.
Starts slideshow mode.
Name of the method to invoke on the image cycle instance.
this for chaining.
Stops slideshow mode.
Name of the method to invoke on the image cycle instance.
this for chaining.
Stops or starts slideshow mode.
Name of the method to invoke on the image cycle instance.
this for chaining.
Switches to the next image.
Name of the method to invoke on the image cycle instance.
this for chaining.
Pauses slideshow mode.
Name of the method to invoke on the image cycle instance.
this for chaining.
Switches to the previous image.
Name of the method to invoke on the image cycle instance.
this for chaining.
Removes the slideshow from this element.
Name of the method to invoke on the image cycle instance.
this for chaining.
Switches to the image with given index.
0-based index of the image to switch to.
this for chaining.
Store arbitrary data associated with the matched elements.
A string naming the piece of data to set.
The new data value; this can be any Javascript type except undefined.
Store arbitrary data associated with the matched elements.
An object of key-value pairs of data to update.
Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.
Name of the data stored.
undefined is not recognized as a data value. Calls such as .data( "name", undefined )
will return the jQuery object that it was called on, allowing for chaining.
Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.
Name of the data stored.
Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.
Initializes the date picker on the current elements.
Optional settings for configuring the date picker.
This JQuery instance for chaining.
Retrieves the current date picker instance.
Name of the method to call on the widget.
The current date picker instance, or undefined if the widget was not yet initialized.
Removes the widget functionality completely. This will return the element back to its pre-init state.
Name of the method to call on the widget.
This JQuery instance for chaining.
Returns a JQuery object containing the original element or other relevant generated elements.
Name of the method to call on the widget.
A JQuery object with the original element or other relevant generated elements.
Finds the current option of the date picker widget.
Name of the method to call on the widget.
The current options of this date picker widget.
Updates the current options with the given options.
Name of the method to call on the widget.
This JQuery instance for chaining.
Finds the value of the given option.
Name of an option to retrieve.
Name of the method to call on the widget.
Name of an option to retrieve.
The value of the given option.
Sets the value of the given option to the given value.
Name of an option to set.
Name of the method to call on the widget.
Name of an option to set.
Value of the option to set.
This JQuery instance for chaining.
Calls a method of the JQueryPrimeDatePicker.PickerInstance and return the result.
Name of the method to call on the widget.
Name of the method to call on the widget.
Arguments as required by the JQueryPrimeDatePicker.PickerInstance method.
The value as returned by the JQueryPrimeDatePicker.PickerInstance method. Return this JQuery instance for chaining when the instance method has no return value.
Initialize a datepicker
Removes the datepicker functionality completely. This will return the element back to its pre-init state.
'destroy'
Opens the datepicker in a dialog box.
'dialog'
The initial date.
A callback function when a date is selected. The function receives the date text and date picker instance as parameters.
The new settings for the date picker.
The position of the top/left of the dialog as [x, y] or a MouseEvent that contains the coordinates. If not specified the dialog is centered on the screen.
Opens the datepicker in a dialog box.
'dialog'
The initial date.
A callback function when a date is selected. The function receives the date text and date picker instance as parameters.
The new settings for the date picker.
The position of the top/left of the dialog as [x, y] or a MouseEvent that contains the coordinates. If not specified the dialog is centered on the screen.
Opens the datepicker in a dialog box.
'dialog'
The initial date.
A callback function when a date is selected. The function receives the date text and date picker instance as parameters.
The new settings for the date picker.
The position of the top/left of the dialog as [x, y] or a MouseEvent that contains the coordinates. If not specified the dialog is centered on the screen.
Opens the datepicker in a dialog box.
'dialog'
The initial date.
A callback function when a date is selected. The function receives the date text and date picker instance as parameters.
The new settings for the date picker.
The position of the top/left of the dialog as [x, y] or a MouseEvent that contains the coordinates. If not specified the dialog is centered on the screen.
Returns the current date for the datepicker or null if no date has been selected.
'getDate'
Close a previously opened date picker.
'hide'
Determine whether a date picker has been disabled.
'isDisabled'
Redraw the date picker, after having made some external modifications.
'refresh'
Sets the date for the datepicker. The new date may be a Date object or a string in the current date format (e.g., "01/26/2009"), 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 to clear the selected date.
'setDate'
The new date.
Sets the date for the datepicker. The new date may be a Date object or a string in the current date format (e.g., "01/26/2009"), 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 to clear the selected date.
'setDate'
The new date.
Open the date picker. If the datepicker is attached to an input, the input must be visible for the datepicker to be shown.
'show'
Returns a jQuery object containing the datepicker.
'widget'
Get the altField option, after initialization
'option'
'altField'
Set the altField option, after initialization
'option'
'altField'
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.
Set the altField option, after initialization
'option'
'altField'
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.
Set the altField option, after initialization
'option'
'altField'
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.
Get the altFormat option, after initialization
'option'
'altFormat'
Set the altFormat option, after initialization
'option'
'altFormat'
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
Get the appendText option, after initialization
'option'
'appendText'
Set the appendText option, after initialization
'option'
'appendText'
The text to display after each date field, e.g., to show the required format.
Get the autoSize option, after initialization
'option'
'autoSize'
Set the autoSize option, after initialization
'option'
'autoSize'
Set to true to automatically resize the input field to accommodate dates in the current dateFormat.
Get the beforeShow option, after initialization
'option'
'beforeShow'
Get the beforeShow option, after initialization
Set the beforeShow option, after initialization
'option'
'beforeShow'
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.
Get the beforeShow option, after initialization
'option'
'beforeShowDay'
Get the beforeShow option, after initialization
Set the beforeShow option, after initialization
'option'
'beforeShowDay'
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.
Get the buttonImage option, after initialization
'option'
'buttonImage'
Set the buttonImage option, after initialization
'option'
'buttonImage'
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.
Get the buttonImageOnly option, after initialization
'option'
'buttonImageOnly'
Set the buttonImageOnly option, after initialization
'option'
'buttonImageOnly'
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.
Get the buttonText option, after initialization
'option'
'buttonText'
Get the autohide option, after initialization
'option'
'autohide'
Get the endDate after initialization
'option'
'endDate'
Set the buttonText option, after initialization
'option'
'buttonText'
The text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "both".
Get the calculateWeek option, after initialization
'option'
'calculateWeek'
Get the calculateWeek option, after initialization
Set the calculateWeek option, after initialization
'option'
'calculateWeek'
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.
Get the changeMonth option, after initialization
'option'
'changeMonth'
Set the changeMonth option, after initialization
'option'
'changeMonth'
Whether the month should be rendered as a dropdown instead of text.
Get the changeYear option, after initialization
'option'
'changeYear'
Set the changeYear option, after initialization
'option'
'changeYear'
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.
Get the closeText option, after initialization
'option'
'closeText'
Set the closeText option, after initialization
'option'
'closeText'
The text to display for the close link. Use the showButtonPanel option to display this button.
Get the constrainInput option, after initialization
'option'
'constrainInput'
Set the constrainInput option, after initialization
'option'
'constrainInput'
When true, entry in the input field is constrained to those characters allowed by the current dateFormat option.
Get the currentText option, after initialization
'option'
'currentText'
Set the currentText option, after initialization
'option'
'currentText'
The text to display for the current day link. Use the showButtonPanel option to display this button.
Get the dateFormat option, after initialization
'option'
'dateFormat'
Set the dateFormat option, after initialization
'option'
'dateFormat'
The format for parsed and displayed dates. For a full list of the possible formats see the formatDate function.
Get the dayNames option, after initialization
'option'
'dayNames'
Set the dayNames option, after initialization
'option'
'dayNames'
The list of long day names, starting from Sunday, for use as requested via the dateFormat option.
Get the dayNamesMin option, after initialization
'option'
'dayNamesMin'
Set the dayNamesMin option, after initialization
'option'
'dayNamesMin'
The list of minimised day names, starting from Sunday, for use as column headers within the datepicker.
Get the dayNamesShort option, after initialization
'option'
'dayNamesShort'
Set the dayNamesShort option, after initialization
'option'
'dayNamesShort'
The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat option.
Get the defaultDate option, after initialization
'option'
'defaultDate'
Set the defaultDate option, after initialization
'option'
'defaultDate'
A date object containing the default date.
Set the defaultDate option, after initialization
'option'
'defaultDate'
A number of days from today. For example 2 represents two days from today and -1 represents yesterday.
Set the defaultDate option, after initialization
'option'
'defaultDate'
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.
Get the duration option, after initialization
'option'
'duration'
Set the duration option, after initialization
'option'
'duration'
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").
Get the firstDay option, after initialization
'option'
'firstDay'
Set the firstDay option, after initialization
'option'
'firstDay'
Set the first day of the week: Sunday is 0, Monday is 1, etc.
Get the gotoCurrent option, after initialization
'option'
'gotoCurrent'
Set the gotoCurrent option, after initialization
'option'
'gotoCurrent'
When true, the current day link moves to the currently selected date instead of today.
Gets the value currently associated with the specified optionName.
'option'
The name of the option to get.
Initialize a datepicker with the given options
Initializes the datetimepicker on this element. It lets the user select both a date and a time (hour and minute).
Options for the datetimepicker.
this for chaining.
Sets and selects the given date.
Name of the method to invoke.
The new date to select. When not given, unselects the date.
this for chaining.
Finds the currently selected date of the datetimepicker.
Name of the method to invoke.
The currently selected date, or null if no date is selected.
Enables the datetimepicker so that the user can now select a date.
Name of the method to invoke.
this for chaining.
Disables the datetimepicker so that the user cannot select a date anymore.
Name of the method to invoke.
this for chaining.
Sets the minimum allowed date the user may select.
Name of the method to invoke.
Name of the option to set.
New value for the option.
this for chaining.
Sets the maximum allowed date the user may select.
Name of the method to invoke.
Name of the option to set.
New value for the option.
this for chaining.
Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Set a timer to delay execution of subsequent items in the queue.
An integer indicating the number of milliseconds to delay execution of the next item in the queue.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements.
A selector to filter the elements that trigger the event.
A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements.
A selector to filter the elements that trigger the event.
A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names.
A function to execute each time the event is triggered.
Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements.
A selector to filter the elements that trigger the event.
A plain object of one or more event types and functions to execute for them.
Deletes the currently selected text of an INPUT or TEXTAREA element.
this for chaining.
Deletes the text at the given range of an INPUT or TEXTAREA element, optionally moving the cursor to the start of the range.
0-based index pointing to the start of the range to select (inclusive).
0-based index pointing to the end of the range to select (exclusive).
true to position the cursor at the start of the given range, or false otherwise.
this for chaining.
Execute the next function on the queue for the matched elements.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Remove the set of matched elements from the DOM.
A selector expression that filters the set of matched elements to be removed.
Iterate over a jQuery object, executing a function for each matched element.
A function to execute for each matched element.
Remove all child nodes of the set of matched elements from the DOM.
End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
Reduce the set of matched elements to the one at the specified index.
An integer indicating the 0-based position of the element. An integer indicating the position of the element, counting backwards from the last element in the set.
Reduce the set of matched elements to the even ones in the set, numbered from zero.
Merge the contents of an object onto the jQuery prototype to provide new jQuery instance methods.
An object to merge onto the jQuery prototype.
Removes and returns the currently selected text of an INPUT or TEXTAREA element.
The text that was selected. Empty string if no text is selected. undefined if this DOM element is not
supported.
Display the matched elements by fading them to opaque.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display the matched elements by fading them to opaque.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display the matched elements by fading them to opaque.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Hide the matched elements by fading them to transparent.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Hide the matched elements by fading them to transparent.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Hide the matched elements by fading them to transparent.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Adjust the opacity of the matched elements.
A string or number determining how long the animation will run.
A number between 0 and 1 denoting the target opacity.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Adjust the opacity of the matched elements.
A string or number determining how long the animation will run.
A number between 0 and 1 denoting the target opacity.
A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements by animating their opacity.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements by animating their opacity.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements by animating their opacity.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.The file upload widget is initialized by calling the fileupload method on a jQuery collection with the target HTML element.
The target element is usually a container element holding the file upload form, or the file upload form itself, but it can also be just the file input element itself for a customized UI and if a URL is provided as options parameter.
Options for configuring the file upload.
This JQuery instance for chaining.
Sets the given option to the given value.
Name of an option to set.
The method to call on this file upload instance.
Name of an option to set.
The value of the given option
Retrieves the value of the given option.
Name of an option to retrieve.
The method to call on this file upload instance.
Name of an option to retrieve.
The value of the given option.
Sets the given options on this file upload instance.
The method to call on this file upload instance.
Options to apply.
This JQuery instance for chaining.
Return the current set of options. This includes default options.
The method to call on this file upload instance.
An object with all options.
To remove the file upload widget functionality from the element node, call the destroy method. This will also remove any added event listeners.
The method to call on this file upload instance.
This JQuery instance for chaining.
As other widgets based on jQuery UI Widget, the file upload widget can also be enabled.
The method to call on this file upload instance.
As other widgets based on jQuery UI Widget, the file upload widget can also be disabled.
The method to call on this file upload instance.
Finds the overall progress of all uploads.
The method to call on this file upload instance.
The overall progress of all uploads.
Finds the number of currently active uploads.
The method to call on this file upload instance.
The number of active uploads.
Usually, file uploads are invoked by selecting files via file input button or by dropping files on the drop zone.
However it is also possible to upload files programmatically for browsers with support for XHR file uploads.
This uploads files by adding them to the upload queue, the same way that files are added via the file input button or drag & drop.
The method to call on this file upload instance.
A list of files to add to this widget. You can also override options of this widget.
This JQuery instance for chaining.
Usually, file uploads are invoked by selecting files via file input button or by dropping files on the drop zone.
However it is also possible to upload files programmatically for browsers with support for XHR file uploads.
This sends the file directly to the server.
Note: The send API method sends the given files directly, without splitting them up into multiple requests. So if your files argument is made up of 3 files, it will still only send one request. If the multipart option is true, it will still send all 3 files as part of one multipart request, else it will only send the first file. So if you need to send files with multiple requests, either call the send API method multiple times, or use the add API method instead.
The method to call on this file upload instance.
A list of files to add to this widget. You can also override options of this widget.
A jqXHR object that allows to bind callbacks to the AJAX file upload requests.
Reduce the set of matched elements to those that match the selector or pass the function's test.
@param selector_elements_selection_function
selector — A string containing a selector expression to match the current set of elements against. elements — One or more DOM elements to match the current set of elements against. selection — An existing jQuery object to match the current set of elements against. function — A function used as a test for each element in the set. this is the current DOM element.Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
@param selector_element
selector — A string containing a selector expression to match elements against. element — An element or a jQuery object to match elements against.Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements.
The name of the queue in which to stop animations.
Reduce the set of matched elements to the first in the set.
Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "focusin" event.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "focusin" event.
A function to execute each time the event is triggered.
Bind an event handler to the "focusout" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "focusout" JavaScript event.
A function to execute each time the event is triggered.
Retrieve one of the elements matched by the jQuery object.
A zero-based integer indicating which element to retrieve.
Retrieve the elements matched by the jQuery object. If the value of index is out of bounds — less than the negative number of elements or equal to or greater than the number of elements — it returns undefined.
Finds the position of the cursor for an INPUT or TEXTAREA element in pixels, relative to the top left corner of the INPUT or TEXTAREA element.
The current position of the cursor in pixels, relative to the top left of the element.
Finds the computed value of a CSS style property.
Name of a style.
The value of the given style.
Finds the position of the cursor for an INPUT or TEXTAREA element.
The current position of the cursor, in characters from the first character of the first line.
Returns the selected text of an INPUT or TEXTAREA element.
The selected range, or undefined if this DOM element is not supported.
Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
@param selector_contained
selector — A string containing a selector expression to match elements against. contained — A DOM element to match elements against.Determine whether any of the matched elements are assigned the given class.
The class name to search for.
Set the CSS height of every matched element.
@param value_function
value — An integer representing the number of pixels, or an integer with an optional unit of measure
appended (as a string). function — A function returning the height to set. Receives the index position of the element in the set and
the old height as arguments. Within the function, this refers to the current element in the set.Get the current computed height for the first element in the set of matched elements.
Hide the matched elements.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Hide the matched elements.
A string or number determining how long the animation will run.
@param easing_complete
easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element.Hide the matched elements.
@param duration_complete_options
duration — A string or number determining how long the animation will run. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.
A function to execute when the mouse pointer enters the element.
A function to execute when the mouse pointer leaves the element.
Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements.
A function to execute when the mouse pointer enters or leaves the element.
Set the HTML contents of each element in the set of matched elements.
@param htmlString_function
htmlString — A string of HTML to set as the content of each matched element. function — A function returning the HTML content to set. Receives the index position of the element in the set
and the old HTML value as arguments. jQuery empties the element before calling the function; use the
oldhtml argument to reference the previous content. Within the function, this refers to the current
element in the set.Get the HTML contents of the first element in the set of matched elements.
There are two ways to instantiate. Either statically, or on an element. Element bound timers will only watch for
events inside of them. You may just want page-level activity, in which case you may set up your timers on
document, document.documentElement, and document.body.
$(function() {
// binds to document - shorthand
$.idleTimer();
// binds to document - explicit
$( document ).idleTimer();
// bind to different element
$( "#myTextArea" ).idleTimer();
});
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
There are two ways to instantiate. Either statically, or on an element. Element bound timers will only watch for
events inside of them. You may just want page-level activity, in which case you may set up your timers on
document, document.documentElement, and document.body.
$(function() {
// binds to document - shorthand
$.idleTimer(1000);
// binds to document - explicit
$( document ).idleTimer(1000);
// bind to different element
$( "#myTextArea" ).idleTimer(1000);
});
The timeout period in milliseconds.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
There are two ways to instantiate. Either statically, or on an element. Element bound timers will only watch for
events inside of them. You may just want page-level activity, in which case you may set up your timers on
document, document.documentElement, and document.body.
$(function() {
// binds to document - shorthand
$.idleTimer({
timeout:10000,
idle:true
});
// binds to document - explicit
$( document ).idleTimer({
timeout:10000,
idle:true
});
// bind to different element
$( "#myTextArea" ).idleTimer({
timeout:10000,
idle:true
});
});
The options for this idle timer. Any options not specified explicitly are set to their default values.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
Stop the timer, removes data, removes event bindings to come back from this you will need to instantiate again.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
Saves the remaining time, and stops the timer.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
Starts the timer with remaining time saved when pause was called.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
Restore initial idle state, and restart the timer.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
this JQuery instance for chaining.
Get time left until idle. If currently idle, returns 0.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
The time in milliseconds until the user goes idle. If user is already idle, returns 0.
Get time elapsed since the user went idle or active.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
How long the user has been idle or active, in milliseconds.
Get time the last active.idleTimer event was fired.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
A timestamp (milliseconds since 1 January 1970 UTC) for when the most recent time the user went from idle to active.
Get whether the user is currently idle.
The method to be invoked on this idle timer instance.
Element to watch, defaults to the document.
Unique ID for this idle timer, to support multiple timers on the same page.
true if the user is currently idle, or false if the user is currently active.
Search for a given element from among the matched elements.
@param selector_element
selector — A selector representing a jQuery collection in which to look for an element. element — The DOM element or first element within the jQuery object to look for.Set the CSS inner height of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure
appended (as a string). function — A function returning the inner height (including padding but not border) to set. Receives the index
position of the element in the set and the old inner height as arguments. Within the function, this
refers to the current element in the set.Get the current computed height for the first element in the set of matched elements, including padding but not border.
Set the CSS inner width of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure
appended (as a string). function — A function returning the inner width (including padding but not border) to set. Receives the index
position of the element in the set and the old inner width as arguments. Within the function, this
refers to the current element in the set.Get the current computed inner width for the first element in the set of matched elements, including padding but not border.
Return the default (empty) mask value.
The metadata of the actual mask provided in the mask definitions can be obtained by calling getmetadata. If only a mask is provided the mask definition will be returned by the getmetadata.
Check whether the returned value is masked or not; currently only works reliably when using jquery.val fn
to retrieve the value
Verify whether the current value is complete or not.
Validate a given value against the mask.
Get an option on an existing inputmask.
Name of option to retrieve.
Set an option on an existing inputmask. The option method is intented for adding extra options like callbacks, etc at a later time to the mask.
When extra options are set the mask is automatically reapplied, unless you pas true for the noremask
argument.
Remove the inputmask.
The setvalue functionality is to set a value to the inputmask like you would do with jQuery.val, BUT it
will trigger the internal event used by the inputmask always, whatever the case. This is particular useful
when cloning an inputmask with jQuery.clone. Cloning an inputmask is not a fully functional clone. On the
first event (mouseenter, focus, ...) the inputmask can detect if it where cloned and can reactivate the
masking. However when setting the value with jQuery.val there is none of the events triggered in that case.
The setvalue functionality does this for you.
Gets the unmasked value.
Creates a new Inputmask instance.
A mask pattern or a reference to a predefined alias.
Mask options.
Creates a new Inputmask instance.
Insert every element in the set of matched elements after the target.
A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter.
Insert every element in the set of matched elements before the target.
A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter.
Inserts the text at the given position of an INPUT or TEXTAREA element, optionally moving the cursor to the end if the inserted text.
Text to insert.
0-based index where to insert the text.
true to move the cursor to the end of the inserted text, or false otherwise.
this for chaining.
Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments.
@param selector_function_selection_elements
selector — A string containing a selector expression to match elements against. function — A function used as a test for every element in the set. It accepts two arguments, index, which is
the element's index in the jQuery collection, and element, which is the DOM element. Within the
function, this refers to the current DOM element. selection — An existing jQuery object to match the current set of elements against. elements — One or more elements to match the current set of elements against.Initializes the JScrollPane on the JQuery object.
Optional settings for configuring the scroll pane.
this jQuery instance for chaining.
Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Initializes the keypad on the currently select elements.
Optional settings for customizing the keypad.
This jQuery instance for chaining.
Determine whether the keypad functionality has been disabled for the first of the given field(s).
The method to call on the existing keypad instance.
Whether the input field is disabled.
Disable the keypad for the given field(s) as well as the field itself. Note that a field that is disabled when the keypad is applied to it causes the keypad to become disabled as well.
The method to call on the existing keypad instance.
this jQuery instance for chaining.
Enable the keypad for the given field(s) as well as the field itself.
The method to call on the existing keypad instance.
this jQuery instance for chaining.
Hide the keypad for the given field.
The method to call on the existing keypad instance.
this jQuery instance for chaining.
Pop up the keypad for the given field.
The method to call on the existing keypad instance.
this jQuery instance for chaining.
Remove the keypad functionality from the given field(s).
The method to call on the existing keypad instance.
this jQuery instance for chaining.
Retrieve all of the current settings for the first keypad instance attached to the given field(s).
var settings = $(selector).keypad("option");
var prompt = $(selector).keypad("option").prompt;
The method to call on the existing keypad instance.
this jQuery instance for chaining.
Retrieve one of the current settings for the first keypad instance attached to the given field(s).
The key of the setting to retrieve.
The method to call on the existing keypad instance.
The name of the setting to retrieve.
var settings = $(selector).keypad("option");
var prompt = $(selector).keypad("option", "prompt");
this jQuery instance for chaining.
Update the settings for the keypad instance(s) attached to the given field(s).
$(selector).keypad("option", {
prompt: "Keypad",
keypadOnly: false
});
The method to call on the existing keypad instance.
The new options to set on the keypad instance.
this jQuery instance for chaining.
Update a particular setting for the keypad instance(s) attached to the given field(s).
$(selector).keypad("option", "prompt", "Keypad");
The key of the setting to update.
The method to call on the existing keypad instance.
Name of the option to update.
The new value for the option
this jQuery instance for chaining.
Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Initializes the knob on the current input element. Creates the canvas with the rendered knob.
Options can also be provided as data attributes, e.g.:
<input type="text" class="dial" data-min="-50" data-max="50">
Optional settings for the knob.
this jQuery instance for chaining.
Reduce the set of matched elements to the final one in the set.
Load data from the server and place the returned HTML into the matched element.
A string containing the URL to which the request is sent.
A plain object or string that is sent to the server with the request.
A callback function that is executed when the request completes.
Load data from the server and place the returned HTML into the matched element.
A string containing the URL to which the request is sent.
@param complete_data
complete — A callback function that is executed when the request completes. data — A plain object or string that is sent to the server with the request.Pass each element in the current matched set through a function, producing a new jQuery object containing the return values.
A function object that will be invoked for each element in the current set.
Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Triggers a mousewheel event on this element.
this for chaining.
Registers the given event listener for the mousewheel event.
Callback to invoke when the event occurs.
this for chaining.
Get the immediately following sibling of each element in the set of matched elements. If a selector is provided, it retrieves the next sibling only if it matches that selector.
A string containing a selector expression to match elements against.
Get all following siblings of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.
@param selector_element
selector — A string containing a selector expression to indicate where to stop matching following sibling elements. element — A DOM node or jQuery object indicating where to stop matching following sibling elements.A string containing a selector expression to match elements against.
Remove elements from the set of matched elements.
@param selector_function_selection
selector — A string containing a selector expression, a DOM element, or an array of elements to match against the set. function — A function used as a test for each element in the set. It accepts two arguments, index, which is
the element's index in the jQuery collection, and element, which is the DOM element. Within the
function, this refers to the current DOM element. selection — An existing jQuery object to match the current set of elements against.Reduce the set of matched elements to the odd ones in the set, numbered from zero.
Remove an event handler.
One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
A selector which should match the one originally passed to .on() when attaching event handlers.
A function to execute each time the event is triggered.
Remove an event handler.
One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
@param selector_handler
selector — A selector which should match the one originally passed to .on() when attaching event handlers. handler — A handler function previously attached for the event(s), or the special value false.Remove an event handler.
An object where the string keys represent one or more space-separated event types and optional namespaces, and the values represent handler functions previously attached for the event(s).
A selector which should match the one originally passed to .on() when attaching event handlers.
Remove an event handler.
A jQuery.Event object.
Set the current coordinates of every element in the set of matched elements, relative to the document.
@param coordinates_function
coordinates — An object containing the properties top and left, which are numbers indicating the new top and
left coordinates for the elements. function — A function to return the coordinates to set. Receives the index of the element in the collection as
the first argument and the current coordinates as the second argument. The function should return an
object with the new top and left properties.Get the current coordinates of the first element in the set of matched elements, relative to the document.
Get the closest ancestor element that is positioned.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
@param selector_data
selector — A selector string to filter the descendants of the selected elements that trigger the event. If the
selector is null or omitted, the event is always triggered when it reaches the selected element. data — Data to be passed to the handler in event.data when an event is triggered.A function to execute when the event is triggered.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A function to execute when the event is triggered.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Data to be passed to the handler in event.data when an event occurs.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Data to be passed to the handler in event.data when an event occurs.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
Data to be passed to the handler in event.data when an event occurs.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Data to be passed to the handler in event.data when an event occurs.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Data to be passed to the handler in event.data when an event occurs.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
Data to be passed to the handler in event.data when an event occurs.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
Set the CSS outer height of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure
appended (as a string). function — A function returning the outer height to set. Receives the index position of the element in the set
and the old outer height as arguments. Within the function, this refers to the current element in
the set.Get the current computed outer height (including padding, border, and optionally margin) for the first element in the set of matched elements.
A Boolean indicating whether to include the element's margin in the calculation.
Set the CSS outer width of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure
appended (as a string). function — A function returning the outer width to set. Receives the index position of the element in the set
and the old outer width as arguments. Within the function, this refers to the current element in
the set.Get the current computed outer width (including padding, border, and optionally margin) for the first element in the set of matched elements.
A Boolean indicating whether to include the element's margin in the calculation.
Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or jQuery object.
@param selector_element
selector — A string containing a selector expression to indicate where to stop matching ancestor elements. element — A DOM node or jQuery object indicating where to stop matching ancestor elements.A string containing a selector expression to match elements against.
Get the current coordinates of the first element in the set of matched elements, relative to the offset parent.
Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or jQuery objects to insert at the beginning of each element in the set of matched elements.
Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.
A function that returns an HTML string, DOM element(s), text node(s), or jQuery object to insert at
the beginning of each element in the set of matched elements. Receives the index position of the
element in the set and the old HTML value of the element as arguments. Within the function, this
refers to the current element in the set.
Insert every element in the set of matched elements to the beginning of the target.
A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter.
Get the immediately preceding sibling of each element in the set of matched elements. If a selector is provided, it retrieves the previous sibling only if it matches that selector.
A string containing a selector expression to match elements against.
Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.
@param selector_element
selector — A string containing a selector expression to indicate where to stop matching preceding sibling elements. element — A DOM node or jQuery object indicating where to stop matching preceding sibling elements.A string containing a selector expression to match elements against.
Prints the currently selected element.
Optional settings for printing.
This jQuery instance for chaining.
Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.
The type of queue that needs to be observed.
Object onto which the promise methods have to be attached
Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.
Object onto which the promise methods have to be attached
Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.
The type of queue that needs to be observed.
Set one or more properties for the set of matched elements.
The name of the property to set.
@param value_function
value — A value to set for the property. function — A function returning the value to set. Receives the index position of the element in the set and the
old property value as arguments. Within the function, the keyword this refers to the current element.Set one or more properties for the set of matched elements.
An object of property-value pairs to set.
Get the value of a property for the first element in the set of matched elements.
The name of the property to get.
Add a collection of DOM elements onto the jQuery stack.
An array of elements to push onto the stack and make into a new jQuery object.
The name of a jQuery method that generated the array of elements.
The arguments that were passed in to the jQuery method (for serialization).
Add a collection of DOM elements onto the jQuery stack.
An array of elements to push onto the stack and make into a new jQuery object.
Manipulate the queue of functions to be executed, once for each matched element.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
The new function to add to the queue, with a function to call that will dequeue the next item. An array of functions to replace the current queue contents.
Manipulate the queue of functions to be executed, once for each matched element.
The new function to add to the queue, with a function to call that will dequeue the next item. An array of functions to replace the current queue contents.
Show the queue of functions to be executed on the matched elements.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Specify a function to execute when the DOM is fully loaded.
A function to execute after the DOM is ready.
Remove the set of matched elements from the DOM.
A selector expression that filters the set of matched elements to be removed.
Remove an attribute from each element in the set of matched elements.
An attribute to remove; as of version 1.7, it can be a space-separated list of attributes.
Remove a single class, multiple classes, or all classes from each element in the set of matched elements.
@param className_function
className — One or more space-separated classes to be removed from the class attribute of each matched element. function — A function returning one or more space-separated class names to be removed. Receives the index
position of the element in the set and the old class value as arguments.Remove a previously-stored piece of data.
A string naming the piece of data to delete. An array or space-separated string naming the pieces of data to delete.
Remove a property for the set of matched elements.
The name of the property to remove.
Replace each target element with the set of matched elements.
A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace.
Replaces the currently selected text of an INPUT or TEXTAREA element with the given text. When no text is selected, insert the given text at the current cursor position.
Text to replace the current selection.
this for chaining.
Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.
@param newContent_function
newContent — The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object. function — A function that returns content with which to replace the set of matched elements.Bind an event handler to the "resize" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "resize" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Set the current horizontal position of the scroll bar for each of the set of matched elements.
An integer indicating the new position to set the scroll bar to.
Get the current horizontal position of the scroll bar for the first element in the set of matched elements.
Set the current vertical position of the scroll bar for each of the set of matched elements.
A number indicating the new position to set the scroll bar to.
Get the current vertical position of the scroll bar for the first element in the set of matched elements or set the vertical position of the scroll bar for every matched element.
Bind an event handler to the "select" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "select" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Encode a set of form elements as a string for submission.
Encode a set of form elements as an array of names and values.
Selects the text at given range of an INPUT or TEXTAREA element.
0-based index pointing to the start of the range to select (inclusive).
0-based index pointing to the end of the range to select (exclusive).
this for chaining.
Display the matched elements.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display the matched elements.
A string or number determining how long the animation will run.
@param easing_complete
easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element.Display the matched elements.
@param duration_complete_options
duration — A string or number determining how long the animation will run. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Get the siblings of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Converts each input field in this selection into a signature input field
Settings for customizing the signature widget.
this jQuery instance for chaining.
Update the settings for the signature widgets.
The method to be called on the signature widget.
The new settings for the signature widget.
this jQuery instance for chaining.
Updates a particular setting for the signature instances.
Name of the setting to update.
The method to be called on the signature widget.
Name of the setting to update.
The new value for the setting.
this jQuery instance for chaining.
Retrieves one of the current settings for the first signature instance.
Name of the setting to retrieve.
The method to be called on the signature widget.
Name of the setting to retrieve.
The current value of the given setting.
Retrieves all of the current settings for the first signature instance.
The method to be called on the signature widget.
The settings of the signature widget.
Enables the signature capture functionality.
The method to be called on the signature widget.
this jQuery instance for chaining.
Disables the signature capture functionality.
The method to be called on the signature widget.
this jQuery instance for chaining.
Removes the signature functionality.
The method to be called on the signature widget.
this jQuery instance for chaining.
Erase any current signature within the div(s). This triggers the change event.
The method to be called on the signature widget.
this jQuery instance for chaining.
Determine whether the first signature area has any signature drawn within it.
The method to be called on the signature widget.
true if no signature is currently drawn, or false otherwise.
Convert the first signature to a JSON string for transferral/storage. A sample follows for a signature with two lines:
{
"lines": [
[
[100, 100],
[180, 50],
[180, 150],
[100, 100]
],
[
[140, 75],
[100, 50],
[100, 150],
[140, 125]
]
]
}
The method to be called on the signature widget.
A JSON string with the line data of the signature.
Convert the first signature to a SVG document for transferral/storage. A sample follows for a signature with two lines:
<?xml version="1.0"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg xmlns="http://www.w3.org/2000/svg" width="15cm" height="15cm">
<g fill="#ffffff">
<rect x="0" y="0" width="400" height="200"/>
<g fill="none" stroke="#000000" stroke-width="2">
<polyline points="100,100 180,50 180,150 100,100"/>
<polyline points="140,75 100,50 100,150 140,125"/>
</g>
</g>
</svg>
The method to be called on the signature widget.
An SVG string with the line data of the signature.
Convert the first signature to a data URI for transferral/storage:
data:image/png;base64,iVBORw0KGgoAAAAN...AAAASUVORK5CYII=
The method to be called on the signature widget.
The image format to use. Defaults to image/png.
A string with the data URI of an image with the signature.
Convert the first signature to a data URI for transferral and storage:
data:image/jpeg;base64,iVBORw0KGgoAAAAN...AAAASUVORK5CYII=
The method to be called on the signature widget.
The image format to use. Defaults to image/png.
The image quality for JPEG images. A value between 0 and 1, default is 0.92.
A string with the data URI of an image with the signature.
Redraws the signature from the supplied definition. This triggers the change event.
The method to be called on the signature widget.
The signature data to draw. May be (a) a JSON object or its string representation as obtained
from the toJSON method); or (b) the SVG string as obtained from the toSVG method), or (c) the data URI
string as obtained from the toDataURL method.
this jQuery instance for chaining.
Reduce the set of matched elements to a subset specified by a range of indices.
An integer indicating the 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set.
An integer indicating the 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set. If omitted, the range continues until the end of the set.
Display the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display the matched elements with a sliding motion.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display the matched elements with a sliding motion.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Display or hide the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements with a sliding motion.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements with a sliding motion.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Hide the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Hide the matched elements with a sliding motion.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Hide the matched elements with a sliding motion.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.Stop the currently-running animation on the matched elements.
The name of the queue in which to stop animations.
A Boolean indicating whether to remove queued animation as well. Defaults to false.
A Boolean indicating whether to complete the current animation immediately. Defaults to false.
Stop the currently-running animation on the matched elements.
A Boolean indicating whether to remove queued animation as well. Defaults to false.
A Boolean indicating whether to complete the current animation immediately. Defaults to false.
Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
For an INPUT or TEXTAREA element: Inserts the given prefix at the beginning of the currently selected text, and the given suffix at the end of the currently selected text. When no text is selected, inserts the given prefix and suffix at the current position of the cursor.
Text to insert at the beginning of the currently selected text.
Text to insert at the end of the currently selected text.
this for chaining.
Set the content of each element in the set of matched elements to the specified text.
@param text_function
text — The text to set as the content of each matched element. When Number or Boolean is supplied, it will
be converted to a String representation. function — A function returning the text content to set. Receives the index position of the element in the set
and the old text value as arguments.Get the combined text contents of each element in the set of matched elements, including their descendants.
Initializes the timepicker on this element. It lets the user select a time (hour and minute).
Options for the datetimepicker.
this for chaining.
Retrieve all the elements contained in the jQuery set, as an array.
Display or hide the matched elements.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements.
A string or number determining how long the animation will run.
A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements.
@param duration_complete_options_display
duration — A string or number determining how long the animation will run. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method. display — Use true to show the element or false to hide it.Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the state argument.
@param className_function
className — One or more class names (separated by spaces) to be toggled for each element in the matched set. function — A function that returns class names to be toggled in the class attribute of each element in the
matched set. Receives the index position of the element in the set, the old class value, and the state as arguments.A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed.
Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the state argument.
A boolean value to determine whether the class should be added or removed.
Execute all handlers and behaviors attached to the matched elements for the given event type.
@param eventType_event
eventType — A string containing a JavaScript event type, such as click or submit. event — A `jQuery.Event` object.Additional parameters to pass along to the event handler.
Execute all handlers attached to an element for an event.
@param eventType_event
eventType — A string containing a JavaScript event type, such as click or submit. event — A `jQuery.Event` object.Additional parameters to pass along to the event handler.
Remove a previously-attached event handler from the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
A function to execute each time the event is triggered.
Remove a previously-attached event handler from the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names. A jQuery.Event object.
Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
A selector which will be used to filter the event results.
A string containing a JavaScript event type, such as "click" or "keydown"
A function to execute each time the event is triggered.
Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
A selector which will be used to filter the event results.
@param eventType_events
eventType — A string containing a JavaScript event type, such as "click" or "keydown" events — An object of one or more event types and previously bound functions to unbind from them.Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
A selector which will be used to filter the event results.
Removes the given event listener for the mousewheel event.
Callback to remove.
this for chaining.
Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place.
A selector to check the parent element against. If an element's parent does not match the selector, the element won't be unwrapped.
Set the value of each element in the set of matched elements.
@param value_function
value — A string of text, a number, or an array of strings corresponding to the value of each matched
element to set as selected/checked. function — A function returning the value to set. this is the current element. Receives the index position of
the element in the set and the old value as arguments.Get the current value of the first element in the set of matched elements.
Set the CSS width of each element in the set of matched elements.
@param value_function
value — An integer representing the number of pixels, or an integer along with an optional unit of measure
appended (as a string). function — A function returning the width to set. Receives the index position of the element in the set and the
old width as arguments. Within the function, this refers to the current element in the set.Get the current computed width for the first element in the set of matched elements.
Wrap an HTML structure around each element in the set of matched elements.
@param wrappingElement_function
wrappingElement — A selector, element, HTML string, or jQuery object specifying the structure to wrap around the
matched elements. When you pass a jQuery collection containing more than one element, or a selector
matching more than one element, the first element will be used. function — A callback function returning the HTML content or jQuery object to wrap around the matched elements.
Receives the index position of the element in the set as an argument. Within the function, this
refers to the current element in the set.Wrap an HTML structure around all elements in the set of matched elements.
@param wrappingElement_function
wrappingElement — A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements. function — A callback function returning the HTML content or jQuery object to wrap around all the matched
elements. Within the function, this refers to the first element in the set. Prior to jQuery
3.0, the callback was incorrectly called for every element in the set and received the index
position of the element in the set as an argument.Wrap an HTML structure around the content of each element in the set of matched elements.
@param wrappingElement_function
wrappingElement — An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap
around the content of the matched elements. function — A callback function which generates a structure to wrap around the content of the matched elements.
Receives the index position of the element in the set as an argument. Within the function, this
refers to the current element in the set.Generated using TypeDoc
A string containing the jQuery version number.
``
1.0
````Determine if an object is a jQuery object
````Get the current version of jQuery running on the page