/*!
* Documentation Content
* Copyright (c) 2009 Packt Publishing, http://packtpub.com/
* Copyright (c) 2012 jQuery Foundation, http://jquery.org/
*
* This software consists of voluntary contributions made by many
* individuals. For exact contribution history, see the revision history
* and logs, available at http://github.com/jquery/api.jquery.com
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
intellisense.annotate(jQuery, {
'ajax': function() {
///
/// Perform an asynchronous HTTP (Ajax) request.
/// A string containing the URL to which the request is sent.
/// A set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup(). See jQuery.ajax( settings ) below for a complete list of all settings.
///
///
///
/// Perform an asynchronous HTTP (Ajax) request.
/// A set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup().
///
///
},
'ajaxPrefilter': function() {
///
/// Handle custom Ajax options or modify existing options before each request is sent and before they are processed by $.ajax().
/// An optional string containing one or more space-separated dataTypes
/// A handler to set default values for future Ajax requests.
///
},
'ajaxSetup': function() {
///
/// Set default values for future Ajax requests.
/// A set of key/value pairs that configure the default Ajax request. All options are optional.
///
},
'boxModel': function() {
/// Deprecated in jQuery 1.3 (see jQuery.support). States if the current page, in the user's browser, is being rendered using the W3C CSS Box Model.
///
},
'browser': function() {
/// Contains flags for the useragent, read from navigator.userAgent. We recommend against using this property; please try to use feature detection instead (see jQuery.support). jQuery.browser may be moved to a plugin in a future release of jQuery.
///
},
'browser.version': function() {
/// The version number of the rendering engine for the user's browser.
///
},
'Callbacks': function() {
///
/// A multi-purpose callbacks list object that provides a powerful way to manage callback lists.
/// An optional list of space-separated flags that change how the callback list behaves.
///
},
'contains': function() {
///
/// Check to see if a DOM element is within another DOM element.
/// The DOM element that may contain the other element.
/// The DOM element that may be contained by the other element.
///
///
},
'cssHooks': function() {
/// Hook directly into jQuery to override how particular CSS properties are retrieved or set, normalize CSS property naming, or create custom properties.
///
},
'data': function() {
///
/// Returns value at named data store for the element, as set by jQuery.data(element, name, value), or the full data store for the element.
/// The DOM element to query for the data.
/// Name of the data stored.
///
///
///
/// Returns value at named data store for the element, as set by jQuery.data(element, name, value), or the full data store for the element.
/// The DOM element to query for the data.
///
///
},
'dequeue': function() {
///
/// Execute the next function on the queue for the matched element.
/// A DOM element from which to remove and execute a queued function.
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
///
///
},
'each': function() {
///
/// A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties.
/// The object or array to iterate over.
/// The function that will be executed on every object.
///
///
},
'error': function() {
///
/// Takes a string and throws an exception containing it.
/// The message to send out.
///
},
'extend': function() {
///
/// Merge the contents of two or more objects together into the first object.
/// An object that will receive the new properties if additional objects are passed in or that will extend the jQuery namespace if it is the sole argument.
/// An object containing additional properties to merge in.
/// Additional objects containing properties to merge in.
///
///
///
/// Merge the contents of two or more objects together into the first object.
/// If true, the merge becomes recursive (aka. deep copy).
/// The object to extend. It will receive the new properties.
/// An object containing additional properties to merge in.
/// Additional objects containing properties to merge in.
///
///
},
'get': function() {
///
/// Load data from the server using a HTTP GET request.
/// A string containing the URL to which the request is sent.
/// A map or string that is sent to the server with the request.
/// A callback function that is executed if the request succeeds.
/// The type of data expected from the server. Default: Intelligent Guess (xml, json, script, or html).
///
///
},
'getJSON': function() {
///
/// Load JSON-encoded data from the server using a GET HTTP request.
/// A string containing the URL to which the request is sent.
/// A map or string that is sent to the server with the request.
/// A callback function that is executed if the request succeeds.
///
///
},
'getScript': function() {
///
/// Load a JavaScript file from the server using a GET HTTP request, then execute it.
/// A string containing the URL to which the request is sent.
/// A callback function that is executed if the request succeeds.
///
///
},
'globalEval': function() {
///
/// Execute some JavaScript code globally.
/// The JavaScript code to execute.
///
},
'grep': function() {
///
/// Finds the elements of an array which satisfy a filter function. The original array is not affected.
/// The array to search through.
/// The function to process each item against. The first argument to the function is the item, and the second argument is the index. The function should return a Boolean value. this will be the global window object.
/// If "invert" is false, or not provided, then the function returns an array consisting of all elements for which "callback" returns true. If "invert" is true, then the function returns an array consisting of all elements for which "callback" returns false.
///
///
},
'hasData': function() {
///
/// Determine whether an element has any jQuery data associated with it.
/// A DOM element to be checked for data.
///
///
},
'holdReady': function() {
///
/// Holds or releases the execution of jQuery's ready event.
/// Indicates whether the ready hold is being requested or released
///
},
'inArray': function() {
///
/// Search for a specified value within an array and return its index (or -1 if not found).
/// The value to search for.
/// An array through which to search.
/// The index of the array at which to begin the search. The default is 0, which will search the whole array.
///
///
},
'isArray': function() {
///
/// Determine whether the argument is an array.
/// Object to test whether or not it is an array.
///
///
},
'isEmptyObject': function() {
///
/// Check to see if an object is empty (contains no properties).
/// The object that will be checked to see if it's empty.
///
///
},
'isFunction': function() {
///
/// Determine if the argument passed is a Javascript function object.
/// Object to test whether or not it is a function.
///
///
},
'isNumeric': function() {
///
/// Determines whether its argument is a number.
/// The value to be tested.
///
///
},
'isPlainObject': function() {
///
/// Check to see if an object is a plain object (created using "{}" or "new Object").
/// The object that will be checked to see if it's a plain object.
///
///
},
'isWindow': function() {
///
/// Determine whether the argument is a window.
/// Object to test whether or not it is a window.
///
///
},
'isXMLDoc': function() {
///
/// Check to see if a DOM node is within an XML document (or is an XML document).
/// The DOM node that will be checked to see if it's in an XML document.
///
///
},
'makeArray': function() {
///
/// Convert an array-like object into a true JavaScript array.
/// Any object to turn into a native Array.
///
///
},
'map': function() {
///
/// Translate all items in an array or object to new array of items.
/// The Array to translate.
/// The function to process each item against. The first argument to the function is the array item, the second argument is the index in array The function can return any value. Within the function, this refers to the global (window) object.
///
///
///
/// Translate all items in an array or object to new array of items.
/// The Array or Object to translate.
/// The function to process each item against. The first argument to the function is the value; the second argument is the index or key of the array or object property. The function can return any value to add to the array. A returned array will be flattened into the resulting array. Within the function, this refers to the global (window) object.
///
///
},
'merge': function() {
///
/// Merge the contents of two arrays together into the first array.
/// The first array to merge, the elements of second added.
/// The second array to merge into the first, unaltered.
///
///
},
'noConflict': function() {
///
/// Relinquish jQuery's control of the $ variable.
/// A Boolean indicating whether to remove all jQuery variables from the global scope (including jQuery itself).
///
///
},
'noop': function() {
/// An empty function.
///
},
'now': function() {
/// Return a number representing the current time.
///
},
'param': function() {
///
/// Create a serialized representation of an array or object, suitable for use in a URL query string or Ajax request.
/// An array or object to serialize.
///
///
///
/// Create a serialized representation of an array or object, suitable for use in a URL query string or Ajax request.
/// An array or object to serialize.
/// A Boolean indicating whether to perform a traditional "shallow" serialization.
///
///
},
'parseJSON': function() {
///
/// Takes a well-formed JSON string and returns the resulting JavaScript object.
/// The JSON string to parse.
///
///
},
'parseXML': function() {
///
/// Parses a string into an XML document.
/// a well-formed XML string to be parsed
///
///
},
'post': function() {
///
/// Load data from the server using a HTTP POST request.
/// A string containing the URL to which the request is sent.
/// A map or string that is sent to the server with the request.
/// A callback function that is executed if the request succeeds.
/// The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html).
///
///
},
'proxy': function() {
///
/// Takes a function and returns a new one that will always have a particular context.
/// The function whose context will be changed.
/// The object to which the context (this) of the function should be set.
///
///
///
/// Takes a function and returns a new one that will always have a particular context.
/// The object to which the context of the function should be set.
/// The name of the function whose context will be changed (should be a property of the context object).
///
///
},
'queue': function() {
///
/// Manipulate the queue of functions to be executed on the matched element.
/// A DOM element where the array of queued functions is attached.
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// An array of functions to replace the current queue contents.
///
///
///
/// Manipulate the queue of functions to be executed on the matched element.
/// A DOM element on which to add a queued function.
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// The new function to add to the queue.
///
///
},
'removeData': function() {
///
/// Remove a previously-stored piece of data.
/// A DOM element from which to remove data.
/// A string naming the piece of data to remove.
///
///
},
'sub': function() {
/// Creates a new copy of jQuery whose properties and methods can be modified without affecting the original jQuery object.
///
},
'support': function() {
/// A collection of properties that represent the presence of different browser features or bugs. Primarily intended for jQuery's internal use; specific properties may be removed when they are no longer needed internally to improve page startup performance.
///
},
'trim': function() {
///
/// Remove the whitespace from the beginning and end of a string.
/// The string to trim.
///
///
},
'type': function() {
///
/// Determine the internal JavaScript [[Class]] of an object.
/// Object to get the internal JavaScript [[Class]] of.
///
///
},
'unique': function() {
///
/// Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.
/// The Array of DOM elements.
///
///
},
'when': function() {
///
/// Provides a way to execute callback functions based on one or more objects, usually Deferred objects that represent asynchronous events.
/// One or more Deferred objects, or plain JavaScript objects.
///
///
},
});
var _1228819969 = jQuery.Callbacks;
jQuery.Callbacks = function(flags) {
var _object = _1228819969(flags);
intellisense.annotate(_object, {
'add': function() {
///
/// Add a callback or a collection of callbacks to a callback list.
/// A function, or array of functions, that are to be added to the callback list.
///
},
'disable': function() {
/// Disable a callback list from doing anything more.
},
'empty': function() {
/// Remove all of the callbacks from a list.
},
'fire': function() {
///
/// Call all of the callbacks with the given arguments
/// The argument or list of arguments to pass back to the callback list.
///
},
'fired': function() {
/// Determine if the callbacks have already been called at least once.
///
},
'fireWith': function() {
///
/// Call all callbacks in a list with the given context and arguments.
/// A reference to the context in which the callbacks in the list should be fired.
/// An argument, or array of arguments, to pass to the callbacks in the list.
///
},
'has': function() {
///
/// Determine whether a supplied callback is in a list
/// The callback to search for.
///
///
},
'lock': function() {
/// Lock a callback list in its current state.
},
'locked': function() {
/// Determine if the callbacks list has been locked.
///
},
'remove': function() {
///
/// Remove a callback or a collection of callbacks from a callback list.
/// A function, or array of functions, that are to be removed from the callback list.
///
},
});
return _object;
};
var _731531622 = jQuery.Deferred;
jQuery.Deferred = function(func) {
var _object = _731531622(func);
intellisense.annotate(_object, {
'always': function() {
///
/// Add handlers to be called when the Deferred object is either resolved or rejected.
/// A function, or array of functions, that is called when the Deferred is resolved or rejected.
/// Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected.
///
///
},
'done': function() {
///
/// Add handlers to be called when the Deferred object is resolved.
/// A function, or array of functions, that are called when the Deferred is resolved.
/// Optional additional functions, or arrays of functions, that are called when the Deferred is resolved.
///
///
},
'fail': function() {
///
/// Add handlers to be called when the Deferred object is rejected.
/// A function, or array of functions, that are called when the Deferred is rejected.
/// Optional additional functions, or arrays of functions, that are called when the Deferred is rejected.
///
///
},
'isRejected': function() {
/// Determine whether a Deferred object has been rejected.
///
},
'isResolved': function() {
/// Determine whether a Deferred object has been resolved.
///
},
'notify': function() {
///
/// Call the progressCallbacks on a Deferred object with the given args.
/// Optional arguments that are passed to the progressCallbacks.
///
///
},
'notifyWith': function() {
///
/// Call the progressCallbacks on a Deferred object with the given context and args.
/// Context passed to the progressCallbacks as the this object.
/// Optional arguments that are passed to the progressCallbacks.
///
///
},
'pipe': function() {
///
/// Utility method to filter and/or chain Deferreds.
/// An optional function that is called when the Deferred is resolved.
/// An optional function that is called when the Deferred is rejected.
///
///
///
/// Utility method to filter and/or chain Deferreds.
/// An optional function that is called when the Deferred is resolved.
/// An optional function that is called when the Deferred is rejected.
/// An optional function that is called when progress notifications are sent to the Deferred.
///
///
},
'progress': function() {
///
/// Add handlers to be called when the Deferred object generates progress notifications.
/// A function, or array of functions, that is called when the Deferred generates progress notifications.
///
///
},
'promise': function() {
///
/// Return a Deferred's Promise object.
/// Object onto which the promise methods have to be attached
///
///
},
'reject': function() {
///
/// Reject a Deferred object and call any failCallbacks with the given args.
/// Optional arguments that are passed to the failCallbacks.
///
///
},
'rejectWith': function() {
///
/// Reject a Deferred object and call any failCallbacks with the given context and args.
/// Context passed to the failCallbacks as the this object.
/// An optional array of arguments that are passed to the failCallbacks.
///
///
},
'resolve': function() {
///
/// Resolve a Deferred object and call any doneCallbacks with the given args.
/// Optional arguments that are passed to the doneCallbacks.
///
///
},
'resolveWith': function() {
///
/// Resolve a Deferred object and call any doneCallbacks with the given context and args.
/// Context passed to the doneCallbacks as the this object.
/// An optional array of arguments that are passed to the doneCallbacks.
///
///
},
'state': function() {
/// Determine the current state of a Deferred object.
///
},
'then': function() {
///
/// Add handlers to be called when the Deferred object is resolved or rejected.
/// A function, or array of functions, called when the Deferred is resolved.
/// A function, or array of functions, called when the Deferred is rejected.
///
///
///
/// Add handlers to be called when the Deferred object is resolved or rejected.
/// A function, or array of functions, called when the Deferred is resolved.
/// A function, or array of functions, called when the Deferred is rejected.
/// A function, or array of functions, called when the Deferred notifies progress.
///
///
},
});
return _object;
};
intellisense.annotate(jQuery.Event.prototype, {
'currentTarget': function() {
/// The current DOM element within the event bubbling phase.
///
},
'data': function() {
/// An optional data map passed to an event method when the current executing handler is bound.
},
'delegateTarget': function() {
/// The element where the currently-called jQuery event handler was attached.
///
},
'isDefaultPrevented': function() {
/// Returns whether event.preventDefault() was ever called on this event object.
///
},
'isImmediatePropagationStopped': function() {
/// Returns whether event.stopImmediatePropagation() was ever called on this event object.
///
},
'isPropagationStopped': function() {
/// Returns whether event.stopPropagation() was ever called on this event object.
///
},
'namespace': function() {
/// The namespace specified when the event was triggered.
///
},
'pageX': function() {
/// The mouse position relative to the left edge of the document.
///
},
'pageY': function() {
/// The mouse position relative to the top edge of the document.
///
},
'preventDefault': function() {
/// If this method is called, the default action of the event will not be triggered.
},
'relatedTarget': function() {
/// The other DOM element involved in the event, if any.
///
},
'result': function() {
/// The last value returned by an event handler that was triggered by this event, unless the value was undefined.
///
},
'stopImmediatePropagation': function() {
/// Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.
},
'stopPropagation': function() {
/// Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.
},
'target': function() {
/// The DOM element that initiated the event.
///
},
'timeStamp': function() {
/// The difference in milliseconds between the time the browser created the event and January 1, 1970.
///
},
'type': function() {
/// Describes the nature of the event.
///
},
'which': function() {
/// For key or mouse events, this property indicates the specific key or button that was pressed.
///
},
});
intellisense.annotate(jQuery.fn, {
'add': function() {
///
/// Add elements to the set of matched elements.
/// A string representing a selector expression to find additional elements to add to the set of matched elements.
///
///
///
/// Add elements to the set of matched elements.
/// One or more elements to add to the set of matched elements.
///
///
///
/// Add elements to the set of matched elements.
/// An HTML fragment to add to the set of matched elements.
///
///
///
/// Add elements to the set of matched elements.
/// An existing jQuery object to add to the set of matched elements.
///
///
///
/// Add elements 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.
///
///
},
'addClass': function() {
///
/// Adds the specified class(es) to each of the set of matched elements.
/// One or more class names to be added to the class attribute of each matched element.
///
///
///
/// Adds the specified class(es) to each of the set of matched elements.
/// 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.
///
///
},
'after': function() {
///
/// Insert content, specified by the parameter, after each element in the set of matched elements.
/// HTML string, DOM element, or jQuery object to insert after each element in the set of matched elements.
/// One or more additional DOM elements, arrays of elements, 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.
/// A function that returns an HTML string, DOM element(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.
///
///
},
'ajaxComplete': function() {
///
/// Register a handler to be called when Ajax requests complete. This is an Ajax Event.
/// The function to be invoked.
///
///
},
'ajaxError': function() {
///
/// Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.
/// The function to be invoked.
///
///
},
'ajaxSend': function() {
///
/// Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.
/// The function to be invoked.
///
///
},
'ajaxStart': function() {
///
/// Register a handler to be called when the first Ajax request begins. This is an Ajax Event.
/// The function to be invoked.
///
///
},
'ajaxStop': function() {
///
/// Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.
/// The function to be invoked.
///
///
},
'ajaxSuccess': function() {
///
/// Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.
/// The function to be invoked.
///
///
},
'all': function() {
/// Selects all elements.
},
'andSelf': function() {
/// Add the previous set of elements on the stack to the current set.
///
},
'animate': function() {
///
/// Perform a custom animation of a set of CSS properties.
/// A map of CSS properties 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.
///
///
///
/// Perform a custom animation of a set of CSS properties.
/// A map of CSS properties that the animation will move toward.
/// A map of additional options to pass to the method. Supported keys: 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.step: A function to be called after each step of the animation.queue: A Boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7, the queue option can also accept a string, in which case the animation is added to the queue represented by that string.specialEasing: A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).
///
///
},
'animated': function() {
/// Select all elements that are in the progress of an animation at the time the selector is run.
},
'append': function() {
///
/// Insert content, specified by the parameter, to the end of each element in the set of matched elements.
/// DOM element, HTML string, or jQuery object to insert at the end of each element in the set of matched elements.
/// One or more additional DOM elements, arrays of elements, 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), 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.
///
///
},
'appendTo': function() {
///
/// Insert every element in the set of matched elements to the end of the target.
/// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter.
///
///
},
'attr': function() {
///
/// Set one or more attributes for the set of matched elements.
/// The name of the attribute to set.
/// A value to set for the attribute.
///
///
///
/// Set one or more attributes for the set of matched elements.
/// A map of attribute-value pairs to set.
///
///
///
/// Set one or more attributes for the set of matched elements.
/// The name of the attribute to set.
/// 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.
///
///
},
'attributeContains': function() {
///
/// Selects elements that have the specified attribute with a value containing the a given substring.
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'attributeContainsPrefix': function() {
///
/// Selects elements that have the specified attribute with a value either equal to a given string or starting with that string followed by a hyphen (-).
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'attributeContainsWord': function() {
///
/// Selects elements that have the specified attribute with a value containing a given word, delimited by spaces.
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'attributeEndsWith': function() {
///
/// Selects elements that have the specified attribute with a value ending exactly with a given string. The comparison is case sensitive.
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'attributeEquals': function() {
///
/// Selects elements that have the specified attribute with a value exactly equal to a certain value.
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'attributeHas': function() {
///
/// Selects elements that have the specified attribute, with any value.
/// An attribute name.
///
},
'attributeMultiple': function() {
///
/// Matches elements that match all of the specified attribute filters.
/// An attribute filter.
/// Another attribute filter, reducing the selection even more
/// As many more attribute filters as necessary
///
},
'attributeNotEqual': function() {
///
/// Select elements that either don't have the specified attribute, or do have the specified attribute but not with a certain value.
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'attributeStartsWith': function() {
///
/// Selects elements that have the specified attribute with a value beginning exactly with a given string.
/// An attribute name.
/// An attribute value. Can be either an unquoted single word or a quoted string.
///
},
'before': function() {
///
/// Insert content, specified by the parameter, before each element in the set of matched elements.
/// HTML string, DOM element, or jQuery object to insert before each element in the set of matched elements.
/// One or more additional DOM elements, arrays of elements, 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.
/// A function that returns an HTML string, DOM element(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.
///
///
},
'bind': function() {
///
/// 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.
/// A map of 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.
/// A map of data that will be passed to the event handler.
/// 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.
/// A map of one or more DOM event types and functions to execute for them.
///
///
},
'blur': function() {
///
/// 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 "blur" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'button': function() {
/// Selects all button elements and elements of type button.
},
'change': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "change" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'checkbox': function() {
/// Selects all elements of type checkbox.
},
'checked': function() {
/// Matches all elements that are checked.
},
'child': function() {
///
/// Selects all direct child elements specified by "child" of elements specified by "parent".
/// Any valid selector.
/// A selector to filter the child elements.
///
},
'children': function() {
///
/// 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.
///
///
},
'class': function() {
///
/// Selects all elements with the given class.
/// A class to search for. An element can have multiple classes; only one of them must match.
///
},
'clearQueue': function() {
///
/// 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.
///
///
},
'click': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "click" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'clone': function() {
///
/// Create a deep copy of the set of matched elements.
/// A Boolean indicating whether event handlers should be copied along with the elements. As of jQuery 1.4, element data will be copied as well.
///
///
///
/// 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).
///
///
},
'closest': function() {
///
/// Get the first element that matches the selector, beginning at the current element and progressing up through the DOM tree.
/// A string containing a selector expression to match elements against.
///
///
///
/// Get the first element that matches the selector, beginning at the current element and progressing up through the DOM tree.
/// A string containing a selector expression to match elements against.
/// A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead.
///
///
///
/// Get the first element that matches the selector, beginning at the current element and progressing up through the DOM tree.
/// A jQuery object to match elements against.
///
///
///
/// Get the first element that matches the selector, beginning at the current element and progressing up through the DOM tree.
/// An element to match elements against.
///
///
},
'contains': function() {
///
/// Select all elements that contain the specified text.
/// A string of text to look for. It's case sensitive.
///
},
'contents': function() {
/// Get the children of each element in the set of matched elements, including text and comment nodes.
///
},
'context': function() {
/// The DOM node context originally passed to jQuery(); if none was passed then context will likely be the document.
///
},
'css': function() {
///
/// Set one or more CSS properties for the set of matched elements.
/// A CSS property name.
/// A value to set for the property.
///
///
///
/// Set one or more CSS properties for the set of matched elements.
/// A CSS property name.
/// 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.
/// A map of property-value pairs to set.
///
///
},
'data': function() {
///
/// Store arbitrary data associated with the matched elements.
/// A string naming the piece of data to set.
/// The new data value; it can be any Javascript type including Array or Object.
///
///
///
/// Store arbitrary data associated with the matched elements.
/// An object of key-value pairs of data to update.
///
///
},
'dblclick': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'delay': function() {
///
/// 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.
///
///
},
'delegate': function() {
///
/// 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 at the 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 map of data that will be passed to the event handler.
/// A function to execute at the 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 map of one or more event types and functions to execute for them.
///
///
},
'dequeue': function() {
///
/// 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.
///
///
},
'descendant': function() {
///
/// Selects all elements that are descendants of a given ancestor.
/// Any valid selector.
/// A selector to filter the descendant elements.
///
},
'detach': function() {
///
/// Remove the set of matched elements from the DOM.
/// A selector expression that filters the set of matched elements to be removed.
///
///
},
'die': function() {
///
/// Remove an event handler previously attached using .live() from the elements.
/// A string containing a JavaScript event type, such as click or keydown.
/// The function that is no longer to be executed.
///
///
///
/// Remove an event handler previously attached using .live() from the elements.
/// A map of one or more event types, such as click or keydown and their corresponding functions that are no longer to be executed.
///
///
},
'disabled': function() {
/// Selects all elements that are disabled.
},
'each': function() {
///
/// Iterate over a jQuery object, executing a function for each matched element.
/// A function to execute for each matched element.
///
///
},
'element': function() {
///
/// Selects all elements with the given tag name.
/// An element to search for. Refers to the tagName of DOM nodes.
///
},
'empty': function() {
/// Select all elements that have no children (including text nodes).
},
'enabled': function() {
/// Selects all elements that are enabled.
},
'end': function() {
/// End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
///
},
'eq': function() {
///
/// Reduce the set of matched elements to the one at the specified index.
/// An integer indicating the 0-based position of the element.
///
///
///
/// Reduce the set of matched elements to the one at the specified index.
/// An integer indicating the position of the element, counting backwards from the last element in the set.
///
///
},
'error': function() {
///
/// Bind an event handler to the "error" JavaScript event.
/// A function to execute when the event is triggered.
///
///
///
/// Bind an event handler to the "error" JavaScript event.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'even': function() {
/// Selects even elements, zero-indexed. See also odd.
},
'fadeIn': function() {
///
/// Display the matched elements by fading them to opaque.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'fadeOut': function() {
///
/// Hide the matched elements by fading them to transparent.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'fadeTo': function() {
///
/// 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.
///
///
///
/// 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.
///
///
},
'fadeToggle': function() {
///
/// 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.
///
///
},
'file': function() {
/// Selects all elements of type file.
},
'filter': function() {
///
/// Reduce the set of matched elements to those that match the selector or pass the function's test.
/// A string containing a selector expression to match the current set of elements against.
///
///
///
/// Reduce the set of matched elements to those that match the selector or pass the function's test.
/// A function used as a test for each element in the set. this is the current DOM element.
///
///
///
/// Reduce the set of matched elements to those that match the selector or pass the function's test.
/// An element to match the current set of elements against.
///
///
///
/// Reduce the set of matched elements to those that match the selector or pass the function's test.
/// An existing jQuery object to match the current set of elements against.
///
///
},
'find': function() {
///
/// Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
/// A string containing a selector expression to match elements against.
///
///
///
/// Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
/// A jQuery object to match elements against.
///
///
///
/// Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
/// An element to match elements against.
///
///
},
'first': function() {
/// Selects the first matched element.
},
'first-child': function() {
/// Selects all elements that are the first child of their parent.
},
'focus': function() {
///
/// 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 "focus" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'focusin': function() {
///
/// Bind an event handler to the "focusin" event.
/// A function to execute each time the event is triggered.
///
///
///
/// Bind an event handler to the "focusin" event.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'focusout': function() {
///
/// Bind an event handler to the "focusout" JavaScript event.
/// A function to execute each time the event is triggered.
///
///
///
/// Bind an event handler to the "focusout" JavaScript event.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'get': function() {
///
/// Retrieve the DOM elements matched by the jQuery object.
/// A zero-based integer indicating which element to retrieve.
///
///
},
'gt': function() {
///
/// Select all elements at an index greater than index within the matched set.
/// Zero-based index.
///
},
'has': function() {
///
/// Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
/// A string containing a selector expression to match elements against.
///
///
///
/// Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
/// A DOM element to match elements against.
///
///
},
'hasClass': function() {
///
/// Determine whether any of the matched elements are assigned the given class.
/// The class name to search for.
///
///
},
'header': function() {
/// Selects all elements that are headers, like h1, h2, h3 and so on.
},
'height': function() {
///
/// Set the CSS height of every matched element.
/// An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string).
///
///
///
/// Set the CSS height of every matched element.
/// 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.
///
///
},
'hidden': function() {
/// Selects all elements that are hidden.
},
'hide': function() {
///
/// Hide the matched elements.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'hover': function() {
///
/// 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.
///
///
},
'html': function() {
///
/// Set the HTML contents of each element in the set of matched elements.
/// A string of HTML to set as the content of each matched element.
///
///
///
/// Set the HTML contents of each element in the set of matched elements.
/// 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.
///
///
},
'id': function() {
///
/// Selects a single element with the given id attribute.
/// An ID to search for, specified via the id attribute of an element.
///
},
'image': function() {
/// Selects all elements of type image.
},
'index': function() {
///
/// Search for a given element from among the matched elements.
/// A selector representing a jQuery collection in which to look for an element.
///
///
///
/// Search for a given element from among the matched elements.
/// The DOM element or first element within the jQuery object to look for.
///
///
},
'init': function() {
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// A string containing a selector expression
/// A DOM Element, Document, or jQuery to use as context
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// A DOM element to wrap in a jQuery object.
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// A plain object to wrap in a jQuery object.
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// An array containing a set of DOM elements to wrap in a jQuery object.
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// An existing jQuery object to clone.
///
///
},
'innerHeight': function() {
/// Get the current computed height for the first element in the set of matched elements, including padding but not border.
///
},
'innerWidth': function() {
/// Get the current computed width for the first element in the set of matched elements, including padding but not border.
///
},
'input': function() {
/// Selects all input, textarea, select and button elements.
},
'insertAfter': function() {
///
/// Insert every element in the set of matched elements after the target.
/// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter.
///
///
},
'insertBefore': function() {
///
/// Insert every element in the set of matched elements before the target.
/// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter.
///
///
},
'is': function() {
///
/// 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.
/// A string containing a selector expression to match elements against.
///
///
///
/// 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.
/// A function used as a test for the set of elements. It accepts one argument, index, which is the element's index in the jQuery collection.Within the function, this refers to the current DOM element.
///
///
///
/// 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.
/// An existing jQuery object to match the current set of elements against.
///
///
///
/// 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.
/// An element to match the current set of elements against.
///
///
},
'jquery': function() {
/// A string containing the jQuery version number.
///
},
'keydown': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'keypress': function() {
///
/// 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 "keypress" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'keyup': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'last': function() {
/// Selects the last matched element.
},
'last-child': function() {
/// Selects all elements that are the last child of their parent.
},
'length': function() {
/// The number of elements in the jQuery object.
///
},
'live': function() {
///
/// Attach an event handler for all elements which match the current selector, now and in the future.
/// A string containing a JavaScript event type, such as "click" or "keydown." As of jQuery 1.4 the string can contain multiple, space-separated event types or custom event names.
/// A function to execute at the time the event is triggered.
///
///
///
/// Attach an event handler for all elements which match the current selector, now and in the future.
/// A string containing a JavaScript event type, such as "click" or "keydown." As of jQuery 1.4 the string can contain multiple, space-separated event types or custom event names.
/// A map of data that will be passed to the event handler.
/// A function to execute at the time the event is triggered.
///
///
///
/// Attach an event handler for all elements which match the current selector, now and in the future.
/// A map of one or more JavaScript event types and functions to execute for them.
///
///
},
'load': function() {
///
/// Bind an event handler to the "load" JavaScript event.
/// A function to execute when the event is triggered.
///
///
///
/// Bind an event handler to the "load" JavaScript event.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'lt': function() {
///
/// Select all elements at an index less than index within the matched set.
/// Zero-based index.
///
},
'map': function() {
///
/// 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.
///
///
},
'mousedown': function() {
///
/// 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 the "mousedown" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'mouseenter': function() {
///
/// 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 enters an element, or trigger that handler on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'mouseleave': function() {
///
/// 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 be fired when the mouse leaves an element, or trigger that handler on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'mousemove': function() {
///
/// 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 "mousemove" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'mouseout': function() {
///
/// 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 "mouseout" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'mouseover': function() {
///
/// 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 "mouseover" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'mouseup': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'multiple': function() {
///
/// Selects the combined results of all the specified selectors.
/// Any valid selector.
/// Another valid selector.
/// As many more valid selectors as you like.
///
},
'next': function() {
///
/// 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.
///
///
},
'next adjacent': function() {
///
/// Selects all next elements matching "next" that are immediately preceded by a sibling "prev".
/// Any valid selector.
/// A selector to match the element that is next to the first selector.
///
},
'next siblings': function() {
///
/// Selects all sibling elements that follow after the "prev" element, have the same parent, and match the filtering "siblings" selector.
/// Any valid selector.
/// A selector to filter elements that are the following siblings of the first selector.
///
},
'nextAll': function() {
///
/// 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.
///
///
},
'nextUntil': function() {
///
/// Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.
/// A string containing a selector expression to indicate where to stop matching following sibling elements.
/// 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.
/// A DOM node or jQuery object indicating where to stop matching following sibling elements.
/// A string containing a selector expression to match elements against.
///
///
},
'not': function() {
///
/// Remove elements from the set of matched elements.
/// A string containing a selector expression to match elements against.
///
///
///
/// Remove elements from the set of matched elements.
/// One or more DOM elements to remove from the matched set.
///
///
///
/// Remove elements from the set of matched elements.
/// A function used as a test for each element in the set. this is the current DOM element.
///
///
///
/// Remove elements from the set of matched elements.
/// An existing jQuery object to match the current set of elements against.
///
///
},
'nth-child': function() {
///
/// Selects all elements that are the nth-child of their parent.
/// The index of each child to match, starting with 1, the string even or odd, or an equation ( eg. :nth-child(even), :nth-child(4n) )
///
},
'odd': function() {
/// Selects odd elements, zero-indexed. See also even.
},
'off': function() {
///
/// 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 handler function previously attached for the event(s), or the special value false.
///
///
///
/// Remove an event handler.
/// A map 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.
///
///
},
'offset': function() {
///
/// Set the current coordinates of every element in the set of matched elements, relative to the document.
/// An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.
///
///
///
/// Set the current coordinates of every element in the set of matched elements, relative to the document.
/// 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.
///
///
},
'offsetParent': function() {
/// Get the closest ancestor element that is positioned.
///
},
'on': function() {
///
/// 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. 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.
/// A map 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.
///
///
},
'one': function() {
///
/// Attach a handler to an event for the elements. The handler is executed at most once per element.
/// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.
/// A map of data that will be passed to the event handler.
/// A function to execute at the time the event is triggered.
///
///
///
/// Attach a handler to an event for the elements. The handler is executed at most once per element.
/// 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. 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.
/// A map 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.
///
///
},
'only-child': function() {
/// Selects all elements that are the only child of their parent.
},
'outerHeight': function() {
///
/// Get the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. Returns an integer (without "px") representation of the value or null if called on an empty set of elements.
/// A Boolean indicating whether to include the element's margin in the calculation.
///
///
},
'outerWidth': function() {
///
/// Get the current computed width for the first element in the set of matched elements, including padding and border.
/// A Boolean indicating whether to include the element's margin in the calculation.
///
///
},
'parent': function() {
///
/// 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.
///
///
},
'parents': function() {
///
/// 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.
///
///
},
'parentsUntil': function() {
///
/// 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.
/// A string containing a selector expression to indicate where to stop matching ancestor elements.
/// 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.
/// A DOM node or jQuery object indicating where to stop matching ancestor elements.
/// A string containing a selector expression to match elements against.
///
///
},
'password': function() {
/// Selects all elements of type password.
},
'position': function() {
/// Get the current coordinates of the first element in the set of matched elements, relative to the offset parent.
///
},
'prepend': function() {
///
/// Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.
/// DOM element, array of elements, HTML string, or jQuery object to insert at the beginning of each element in the set of matched elements.
/// One or more additional DOM elements, arrays of elements, 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), 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.
///
///
},
'prependTo': function() {
///
/// Insert every element in the set of matched elements to the beginning of the target.
/// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter.
///
///
},
'prev': function() {
///
/// Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector.
/// A string containing a selector expression to match elements against.
///
///
},
'prevAll': function() {
///
/// 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.
///
///
},
'prevUntil': function() {
///
/// Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.
/// A string containing a selector expression to indicate where to stop matching preceding sibling elements.
/// 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.
/// A DOM node or jQuery object indicating where to stop matching preceding sibling elements.
/// A string containing a selector expression to match elements against.
///
///
},
'promise': function() {
///
/// 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
///
///
},
'prop': function() {
///
/// Set one or more properties for the set of matched elements.
/// The name of the property to set.
/// A value to set for the property.
///
///
///
/// Set one or more properties for the set of matched elements.
/// A map of property-value pairs to set.
///
///
///
/// Set one or more properties for the set of matched elements.
/// The name of the property to set.
/// 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.
///
///
},
'pushStack': function() {
///
/// 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.
///
///
///
/// 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).
///
///
},
'queue': function() {
///
/// Manipulate 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.
/// An array of functions to replace the current queue contents.
///
///
///
/// Manipulate 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.
/// The new function to add to the queue, with a function to call that will dequeue the next item.
///
///
},
'radio': function() {
/// Selects all elements of type radio.
},
'ready': function() {
///
/// Specify a function to execute when the DOM is fully loaded.
/// A function to execute after the DOM is ready.
///
///
},
'remove': function() {
///
/// Remove the set of matched elements from the DOM.
/// A selector expression that filters the set of matched elements to be removed.
///
///
},
'removeAttr': function() {
///
/// 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.
///
///
},
'removeClass': function() {
///
/// Remove a single class, multiple classes, or all classes from each element in the set of matched elements.
/// One or more space-separated classes to be removed from the class attribute of each matched element.
///
///
///
/// Remove a single class, multiple classes, or all classes from each element in the set of matched elements.
/// 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.
///
///
},
'removeData': function() {
///
/// Remove a previously-stored piece of data.
/// A string naming the piece of data to delete.
///
///
///
/// Remove a previously-stored piece of data.
/// An array or space-separated string naming the pieces of data to delete.
///
///
},
'removeProp': function() {
///
/// Remove a property for the set of matched elements.
/// The name of the property to set.
///
///
},
'replaceAll': function() {
///
/// Replace each target element with the set of matched elements.
/// A selector expression indicating which element(s) to replace.
///
///
},
'replaceWith': function() {
///
/// Replace each element in the set of matched elements with the provided new content.
/// The content to insert. May be an HTML string, DOM element, or jQuery object.
///
///
///
/// Replace each element in the set of matched elements with the provided new content.
/// A function that returns content with which to replace the set of matched elements.
///
///
},
'reset': function() {
/// Selects all elements of type reset.
},
'resize': function() {
///
/// 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 "resize" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'scroll': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'scrollLeft': function() {
///
/// 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.
///
///
},
'scrollTop': function() {
///
/// Set the current vertical 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.
///
///
},
'select': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "select" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'selected': function() {
/// Selects all elements that are selected.
},
'serialize': function() {
/// Encode a set of form elements as a string for submission.
///
},
'serializeArray': function() {
/// Encode a set of form elements as an array of names and values.
///
},
'show': function() {
///
/// Display the matched elements.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'siblings': function() {
///
/// 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.
///
///
},
'size': function() {
/// Return the number of elements in the jQuery object.
///
},
'slice': function() {
///
/// 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.
///
///
},
'slideDown': function() {
///
/// Display the matched elements with a sliding motion.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'slideToggle': function() {
///
/// Display or hide the matched elements with a sliding motion.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'slideUp': function() {
///
/// Hide the matched elements with a sliding motion.
/// A string or number determining how long the animation will run.
/// A function to call once the animation is complete.
///
///
///
/// 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.
///
///
},
'stop': function() {
///
/// 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.
///
///
///
/// 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.
///
///
},
'submit': function() {
///
/// 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.
///
///
///
/// Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'text': function() {
///
/// Set the content of each element in the set of matched elements to the specified text.
/// A string of text to set as the content of each matched element.
///
///
///
/// Set the content of each element in the set of matched elements to the specified text.
/// 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.
///
///
},
'toArray': function() {
/// Retrieve all the DOM elements contained in the jQuery set, as an array.
///
},
'toggle': function() {
///
/// 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.
///
///
///
/// 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.
///
///
///
/// Display or hide the matched elements.
/// A Boolean indicating whether to show or hide the elements.
///
///
},
'toggleClass': function() {
///
/// 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 switch argument.
/// One or more class names (separated by spaces) to be toggled for each element in the matched set.
///
///
///
/// 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 switch argument.
/// One or more class names (separated by spaces) to be toggled for each element in the matched set.
/// 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 switch argument.
/// A boolean 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 switch argument.
/// 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 switch as arguments.
/// A boolean value to determine whether the class should be added or removed.
///
///
},
'trigger': function() {
///
/// Execute all handlers and behaviors attached to the matched elements for the given event type.
/// A string containing a JavaScript event type, such as click or submit.
/// Additional parameters to pass along to the event handler.
///
///
///
/// Execute all handlers and behaviors attached to the matched elements for the given event type.
/// A jQuery.Event object.
///
///
},
'triggerHandler': function() {
///
/// Execute all handlers attached to an element for an event.
/// A string containing a JavaScript event type, such as click or submit.
/// An array of additional parameters to pass along to the event handler.
///
///
},
'unbind': function() {
///
/// Remove a previously-attached event handler from the elements.
/// A string containing a JavaScript event type, such as click or submit.
/// The function that is to be no longer executed.
///
///
///
/// Remove a previously-attached event handler from the elements.
/// A string containing a JavaScript event type, such as click or submit.
/// Unbinds the corresponding 'return false' function that was bound using .bind( eventType, false ).
///
///
///
/// Remove a previously-attached event handler from the elements.
/// A JavaScript event object as passed to an event handler.
///
///
},
'undelegate': function() {
///
/// 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"
///
///
///
/// 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 at the 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.
/// A map 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 string containing a namespace to unbind all events from.
///
///
},
'unload': function() {
///
/// Bind an event handler to the "unload" JavaScript event.
/// A function to execute when the event is triggered.
///
///
///
/// Bind an event handler to the "unload" JavaScript event.
/// A map of data that will be passed to the event handler.
/// A function to execute each time the event is triggered.
///
///
},
'unwrap': function() {
/// Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place.
///
},
'val': function() {
///
/// Set the value of each element in the set of matched elements.
/// A string of text or an array of strings corresponding to the value of each matched element to set as selected/checked.
///
///
///
/// Set the value of each element in the set of matched elements.
/// 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.
///
///
},
'visible': function() {
/// Selects all elements that are visible.
},
'width': function() {
///
/// Set the CSS width of each element in the set of matched elements.
/// An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).
///
///
///
/// Set the CSS width of each element in the set of matched elements.
/// 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.
///
///
},
'wrap': function() {
///
/// Wrap an HTML structure around each element in the set of matched elements.
/// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements.
///
///
///
/// Wrap an HTML structure around each element in the set of matched elements.
/// 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.
///
///
},
'wrapAll': function() {
///
/// Wrap an HTML structure around all elements in the set of matched elements.
/// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements.
///
///
},
'wrapInner': function() {
///
/// Wrap an HTML structure around the content of each element in the set of matched elements.
/// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements.
///
///
///
/// Wrap an HTML structure around the content of each element in the set of matched elements.
/// 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.
///
///
},
});
intellisense.annotate(window, {
'$': function() {
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// A string containing a selector expression
/// A DOM Element, Document, or jQuery to use as context
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// A DOM element to wrap in a jQuery object.
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// A plain object to wrap in a jQuery object.
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// An array containing a set of DOM elements to wrap in a jQuery object.
///
///
///
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// An existing jQuery object to clone.
///
///
},
});