$(selector, context)<\/code> method."}]}],"desc":"Add elements to the set of matched elements.","longdesc":"Given a jQuery object that represents a set of DOM elements, the .add()<\/code> method constructs a new jQuery object from the union of those elements and the ones passed into the method. The argument to .add()<\/code> can be pretty much anything that $()<\/code> accepts, including a jQuery selector expression, references to DOM elements, or an HTML snippet.<\/p>\nThe updated set of elements can be used in a following (chained) method, or assigned to a variable for later use. For example:<\/p>\n
\n$(\"p\").add(\"div\").addClass(\"widget\");\nvar pdiv = $(\"p\").add(\"div\");\n<\/pre>\nThe following will not<\/em> save the added elements, because the .add()<\/code> method creates a new set and leaves the original set in pdiv unchanged:<\/p>\n\nvar pdiv = $(\"p\");\npdiv.add(\"div\"); \/\/ WRONG, pdiv will not change\n<\/pre>\nConsider a page with a simple list and a paragraph following it:<\/p>\n
<ul>\n <li>list item 1<\/li>\n <li>list item 2<\/li>\n <li>list item 3<\/li>\n<\/ul>\n<p>a paragraph<\/p><\/pre>\nWe can select the list items and then the paragraph by using either a selector or a reference to the DOM element itself as the .add()<\/code> method's argument:<\/p>\n$('li').add('p').css('background-color', 'red');<\/pre>\nOr:<\/p>\n
$('li').add(document.getElementsByTagName('p')[0])\n .css('background-color', 'red');<\/pre>\nThe result of this call is a red background behind all four elements.\nUsing an HTML snippet as the .add()<\/code> method's argument (as in the third version), we can create additional elements on the fly and add those elements to the matched set of elements. Let's say, for example, that we want to alter the background of the list items along with a newly created paragraph:<\/p>\n$('li').add('<p id=\"new\">new paragraph<\/p>')\n .css('background-color', 'red');<\/pre>\nAlthough the new paragraph has been created and its background color changed, it still does not appear on the page. To place it on the page, we could add one of the insertion methods to the chain.<\/p>\n
As of jQuery 1.4 the results from .add() will always be returned in document order (rather than a simple concatenation).<\/p>\n
Note:<\/strong> To reverse the .add()<\/code> you can use .not( elements | selector )<\/code><\/a> to remove elements from the jQuery results, or .end()<\/code><\/a> to return to the selection before you added.<\/p>\n","categories":["Traversing > Miscellaneous Traversing","Version > Version 1.0","Version > Version 1.4"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/addClass\/","name":"addClass","title":".addClass()","type":"method","signatures":[{"added":"1.0","params":[{"name":"className","type":"String","optional":"","desc":"One or more class names to be added to the class attribute of each matched element."}]},{"added":"1.4","params":[{"name":"function(index, currentClass)","type":"Function","optional":"","desc":"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<\/code> refers to the current element in the set."}]}],"desc":"Adds the specified class(es) to each of the set of matched elements.","longdesc":"It's important to note that this method does not replace a class. It simply adds the class, appending it to any which may already be assigned to the elements.<\/p>\n
More than one class may be added at a time, separated by a space, to the set of matched elements, like so:<\/p>\n
$(\"p\").addClass(\"myClass yourClass\");<\/pre>\n This method is often used with .removeClass()<\/code> to switch elements' classes from one to another, like so:<\/p>\n $(\"p\").removeClass(\"myClass noClass\").addClass(\"yourClass\");<\/pre>\n Here, the myClass<\/code> and noClass<\/code> classes are removed from all paragraphs, while yourClass<\/code> is added.<\/p>\nAs of jQuery 1.4, the .addClass()<\/code> method's argument can receive a function.<\/p>\n$(\"ul li:last\").addClass(function() {\n return \"item-\" + $(this).index();\n});<\/pre>\nGiven an unordered list with five <li><\/code> elements, this example adds the class \"item-4\" to the last <li><\/code>.<\/p>\n\n","categories":["Attributes","Manipulation > Class Attribute","CSS","Version > Version 1.0","Version > Version 1.4"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/after\/","name":"after","title":".after()","type":"method","signatures":[{"added":"1.0","params":[{"name":"content","type":"String, Element, jQuery","optional":"","desc":"HTML string, DOM element, or jQuery object to insert after each element in the set of matched elements."},{"name":"content","type":"String, Element, Array, jQuery","optional":"optional","desc":"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."}]},{"added":"1.4","params":[{"name":"function(index)","type":"Function","optional":"","desc":"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<\/code> refers to the current element in the set."}]}],"desc":"Insert content, specified by the parameter, after each element in the set of matched elements.","longdesc":"The .after()<\/code> and .insertAfter()<\/a><\/code> methods perform the same task. The major difference is in the syntax\u2014specifically, in the placement of the content and target. With .after()<\/code>, the selector expression preceding the method is the container after which the content is inserted. With .insertAfter()<\/code>, on the other hand, the content precedes the method, either as a selector expression or as markup created on the fly, and it is inserted after the target container.<\/p>\n\nUsing the following HTML:<\/p>\n
<div class=\"container\">\n <h2>Greetings<\/h2>\n <div class=\"inner\">Hello<\/div>\n <div class=\"inner\">Goodbye<\/div>\n<\/div><\/pre>\n\nContent can be created and then inserted after several elements at once:<\/p>\n\n
$('.inner').after('<p>Test<\/p>');<\/pre>\n\nEach inner <div><\/code> element gets this new content:<\/p>\n\n<div class=\"container\">\n <h2>Greetings<\/h2>\n <div class=\"inner\">Hello<\/div>\n <p>Test<\/p>\n <div class=\"inner\">Goodbye<\/div>\n <p>Test<\/p>\n<\/div><\/pre>\n\nAn element in the DOM can also be selected and inserted after another element:<\/p>\n\n
$('.container').after($('h2'));<\/pre>\n\nIf an element selected this way is inserted elsewhere, it will be moved rather than cloned:<\/p>\n\n
<div class=\"container\">\n <div class=\"inner\">Hello<\/div>\n <div class=\"inner\">Goodbye<\/div>\n<\/div>\n<h2>Greetings<\/h2><\/pre>\nIf there is more than one target element, however, cloned copies of the inserted element will be created for each target after the first.<\/p>\n
Inserting Disconnected DOM nodes<\/h4>\n
As of jQuery 1.4, .before()<\/code> and .after()<\/code> will also work on disconnected DOM nodes. For example, given the following code:<\/p>\n$('<div\/>').after('<p><\/p>');<\/pre>\nThe result is a jQuery set containing a div and a paragraph, in that order. That set can be further manipulated, even before it is inserted in the document.<\/p>\n
$('<div\/>').after('<p><\/p>').addClass('foo')\n .filter('p').attr('id', 'bar').html('hello')\n.end()\n.appendTo('body');<\/pre>\nThis results in the following elements inserted just before the closing <\/body><\/code> tag:<\/p>\n\n<div class=\"foo\"><\/div>\n<p class=\"foo\" id=\"bar\">hello<\/p>\n<\/pre>\nPassing a Function<\/h4>\n
As of jQuery 1.4, .after()<\/code> supports passing a function that returns the elements to insert.<\/p>\n$('p').after(function() {\n return '<div>' + this.className + '<\/div>';\n});<\/pre>\nThis example inserts a <div><\/code> after each paragraph, with each new <div><\/code> containing the class name(s) of its preceding paragraph.<\/p>\n Additional Arguments<\/h4>\n
Similar to other content-adding methods such as .prepend()<\/a><\/code> and .before()<\/a><\/code>, .after()<\/code> also supports passing in multiple arguments as input. Supported input includes DOM elements, jQuery objects, HTML strings, and arrays of DOM elements.<\/p> \n For example, the following will insert two new <div><\/code>s and an existing <div><\/code> after the first paragraph:<\/p>\nvar $newdiv1 = $('<div id=\"object1\"\/>'),\n newdiv2 = document.createElement('div'),\n existingdiv1 = document.getElementById('foo');\n\n$('p').first().after($newdiv1, [newdiv2, existingdiv1]);\n<\/pre>\nSince .after()<\/code> can accept any number of additional arguments, the same result can be achieved by passing in the three <div><\/code>s as three separate arguments, like so: $('p').first().after($newdiv1, newdiv2, existingdiv1)<\/code>. The type and number of arguments will largely depend on the elements are collected in the code.<\/p>\n\n","categories":["Manipulation > DOM Insertion"," Outside","Version > Version 1.0","Version > Version 1.4"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/ajaxComplete\/","name":"ajaxComplete","title":".ajaxComplete()","type":"method","signatures":[{"added":"1.0","params":[{"name":"handler(event, XMLHttpRequest, ajaxOptions)","type":"Function","optional":"","desc":"The function to be invoked."}]}],"desc":"Register a handler to be called when Ajax requests complete. This is an Ajax Event<\/a>.","longdesc":"Whenever an Ajax request completes, jQuery triggers the ajaxComplete<\/code> event. Any and all handlers that have been registered with the .ajaxComplete()<\/code> method are executed at this time.<\/p>\n\t\t\t\tTo observe this method in action, we can set up a basic Ajax load request:<\/p>\n\t\t\t\t
<div class=\"trigger\">Trigger<\/div>\n<div class=\"result\"><\/div>\n<div class=\"log\"><\/div>\n<\/pre>\n\t\t\t\tWe can attach our event handler to any element:<\/p>\n\t\t\t\t
$('.log').ajaxComplete(function() {\n $(this).text('Triggered ajaxComplete handler.');\n});\n<\/pre>\n\t\t\t\tNow, we can make an Ajax request using any jQuery method:<\/p>\n\t\t\t\t
$('.trigger').click(function() {\n $('.result').load('ajax\/test.html');\n});<\/pre>\n\t\t\t\tWhen the user clicks the button and the Ajax request completes, the log message is displayed.<\/p>\n\n\t\t\t\t
Note:<\/strong> Because .ajaxComplete()<\/code> is implemented as a method of jQuery object instances, we can use the this<\/code> keyword as we do here to refer to the selected elements within the callback function.<\/p>\n\n\t\t\t\tAll ajaxComplete<\/code> handlers are invoked, regardless of what Ajax request was completed. If we must differentiate between the requests, we can use the parameters passed to the handler. Each time an ajaxComplete<\/code> handler is executed, it is passed the event object, the XMLHttpRequest<\/code> object, and the settings object that was used in the creation of the request. For example, we can restrict our callback to only handling events dealing with a particular URL:<\/p>\n\nNote:<\/strong> You can get the returned ajax contents by looking at xhr.responseXML<\/code> or xhr.responseHTML<\/code> for xml and html respectively.<\/p>\n\n\t\t\t\t$('.log').ajaxComplete(function(e, xhr, settings) {\n if (settings.url == 'ajax\/test.html') {\n $(this).text('Triggered ajaxComplete handler. The result is ' +\n xhr.responseHTML);\n }\n});<\/pre>","categories":["Ajax > Global Ajax Event Handlers","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/ajaxError\/","name":"ajaxError","title":".ajaxError()","type":"method","signatures":[{"added":"1.0","params":[{"name":"handler(event, jqXHR, ajaxSettings, thrownError)","type":"Function","optional":"","desc":"The function to be invoked."}]}],"desc":"Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event<\/a>.","longdesc":"Whenever an Ajax request completes with an error, jQuery triggers the ajaxError<\/code> event. Any and all handlers that have been registered with the .ajaxError()<\/code> method are executed at this time.<\/p>\n To observe this method in action, set up a basic Ajax load request.<\/p>\n
<button class=\"trigger\">Trigger<\/button>\n<div class=\"result\"><\/div>\n<div class=\"log\"><\/div><\/pre>\n Attach the event handler to any element:<\/p>\n
$(\"div.log\").ajaxError(function() {\n $(this).text( \"Triggered ajaxError handler.\" );\n});<\/pre>\n Now, make an Ajax request using any jQuery method:<\/p>\n
$(\"button.trigger\").click(function() {\n $(\"div.result\").load( \"ajax\/missing.html\" );\n});<\/pre>\n When the user clicks the button and the Ajax request fails, because the requested file is missing, the log message is displayed.<\/p>\n\n
Note:<\/strong> Because .ajaxError()<\/code> is implemented as a method of jQuery object instances, you can use the this<\/code> keyword within the callback function to refer to the selected elements.<\/p>\n\n All ajaxError<\/code> handlers are invoked, regardless of what Ajax request was completed. To differentiate between the requests, you can use the parameters passed to the handler. Each time an ajaxError<\/code> handler is executed, it is passed the event object, the jqXHR<\/code> object (prior to jQuery 1.5, the XHR<\/abbr><\/code> object), and the settings object that was used in the creation of the request. If the request failed because JavaScript raised an exception, the exception object is passed to the handler as a fourth parameter. For example, to restrict the error callback to only handling events dealing with a particular URL:<\/p>\n$( \"div.log\" ).ajaxError(function(e, jqxhr, settings, exception) {\n if ( settings.url == \"ajax\/missing.html\" ) {\n $(this).text( \"Triggered ajaxError handler.\" );\n }\n});<\/pre>\n ","categories":["Ajax > Global Ajax Event Handlers","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/ajaxSend\/","name":"ajaxSend","title":".ajaxSend()","type":"method","signatures":[{"added":"1.0","params":[{"name":"handler(event, jqXHR, ajaxOptions)","type":"Function","optional":"","desc":"The function to be invoked."}]}],"desc":"Attach a function to be executed before an Ajax request is sent. This is an Ajax Event<\/a>.","longdesc":"\n Whenever an Ajax request is about to be sent, jQuery triggers the ajaxSend<\/code> event. Any and all handlers that have been registered with the .ajaxSend()<\/code> method are executed at this time.<\/p>\n To observe this method in action, we can set up a basic Ajax load request:<\/p>\n
<div class=\"trigger\">Trigger<\/div>\n<div class=\"result\"><\/div>\n<div class=\"log\"><\/div><\/pre>\n We can attach our event handler to any element:<\/p>\n
$('.log').ajaxSend(function() {\n $(this).text('Triggered ajaxSend handler.');\n});<\/pre>\n Now, we can make an Ajax request using any jQuery method:<\/p>\n
$('.trigger').click(function() {\n $('.result').load('ajax\/test.html');\n});<\/pre>\n When the user clicks the button and the Ajax request is about to begin, the log message is displayed.<\/p>\n\n
Note:<\/strong> Because .ajaxSend()<\/code> is implemented as a method of jQuery instances, we can use the this<\/code> keyword as we do here to refer to the selected elements within the callback function.<\/p>\n\n All ajaxSend<\/code> handlers are invoked, regardless of what Ajax request is to be sent. If we must differentiate between the requests, we can use the parameters passed to the handler. Each time an ajaxSend<\/code> handler is executed, it is passed the event object, the jqXHR<\/code> object (in version 1.4, XMLHttpRequest<\/code>object), and the settings object<\/a> that was used in the creation of the Ajax request. For example, we can restrict our callback to only handling events dealing with a particular URL:<\/p>\n $('.log').ajaxSend(function(e, jqxhr, settings) {\n if (settings.url == 'ajax\/test.html') {\n $(this).text('Triggered ajaxSend handler.');\n }\n});<\/pre>\n ","categories":["Ajax > Global Ajax Event Handlers","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/ajaxStart\/","name":"ajaxStart","title":".ajaxStart()","type":"method","signatures":[{"added":"1.0","params":[{"name":"handler()","type":"Function","optional":"","desc":"The function to be invoked."}]}],"desc":"Register a handler to be called when the first Ajax request begins. This is an Ajax Event<\/a>.","longdesc":"Whenever an Ajax request is about to be sent, jQuery checks whether there are any other outstanding Ajax requests. If none are in progress, jQuery triggers the ajaxStart<\/code> event. Any and all handlers that have been registered with the .ajaxStart()<\/code> method are executed at this time.<\/p>\n\t\t\t\tTo observe this method in action, we can set up a basic Ajax load request:<\/p>\n\t\t\t\t
<div class=\"trigger\">Trigger<\/div>\n<div class=\"result\"><\/div>\n<div class=\"log\"><\/div><\/pre>\n\t\t\t\tWe can attach our event handler to any element:<\/p>\n\t\t\t\t
$('.log').ajaxStart(function() {\n $(this).text('Triggered ajaxStart handler.');\n});<\/pre>\n\t\t\t\tNow, we can make an Ajax request using any jQuery method:<\/p>\n\t\t\t\t
$('.trigger').click(function() {\n $('.result').load('ajax\/test.html');\n});<\/pre>\n\t\t\t\tWhen the user clicks the button and the Ajax request is sent, the log message is displayed.<\/p>\n\n\t\t\t\t
Note:<\/strong> Because .ajaxStart()<\/code> is implemented as a method of jQuery object instances, we can use the this<\/code> keyword as we do here to refer to the selected elements within the callback function.<\/p>\n","categories":["Ajax > Global Ajax Event Handlers","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/ajaxStop\/","name":"ajaxStop","title":".ajaxStop()","type":"method","signatures":[{"added":"1.0","params":[{"name":"handler()","type":"Function","optional":"","desc":"The function to be invoked."}]}],"desc":"Register a handler to be called when all Ajax requests have completed. This is an Ajax Event<\/a>.","longdesc":"\n Whenever an Ajax request completes, jQuery checks whether there are any other outstanding Ajax requests. If none remain, jQuery triggers the ajaxStop<\/code> event. Any and all handlers that have been registered with the .ajaxStop()<\/code> method are executed at this time. The ajaxStop<\/code> event is also triggered if the last outstanding Ajax request is cancelled by returning false within the beforeSend<\/code> callback function. <\/p>\n To observe this method in action, we can set up a basic Ajax load request:<\/p>\n
<div class=\"trigger\">Trigger<\/div>\n<div class=\"result\"><\/div>\n<div class=\"log\"><\/div><\/pre>\n We can attach our event handler to any element:<\/p>\n
$('.log').ajaxStop(function() {\n $(this).text('Triggered ajaxStop handler.');\n});<\/pre>\n Now, we can make an Ajax request using any jQuery method:<\/p>\n
$('.trigger').click(function() {\n $('.result').load('ajax\/test.html');\n});<\/pre>\n When the user clicks the button and the Ajax request completes, the log message is displayed.<\/p>\n \t
Because .ajaxStop()<\/code> is implemented as a method of jQuery object instances, we can use the this<\/code> keyword as we do here to refer to the selected elements within the callback function.<\/p>\n ","categories":["Ajax > Global Ajax Event Handlers","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/ajaxSuccess\/","name":"ajaxSuccess","title":".ajaxSuccess()","type":"method","signatures":[{"added":"1.0","params":[{"name":"handler(event, XMLHttpRequest, ajaxOptions)","type":"Function","optional":"","desc":"The function to be invoked."}]}],"desc":"Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event<\/a>.","longdesc":"\n Whenever an Ajax request completes successfully, jQuery triggers the ajaxSuccess<\/code> event. Any and all handlers that have been registered with the .ajaxSuccess()<\/code> method are executed at this time.<\/p>\n To observe this method in action, we can set up a basic Ajax load request:<\/p>\n\t\t
<div class=\"trigger\">Trigger<\/div>\n<div class=\"result\"><\/div>\n<div class=\"log\"><\/div><\/pre>\n We can attach our event handler to any element:<\/p>\n
$('.log').ajaxSuccess(function() {\n $(this).text('Triggered ajaxSuccess handler.');\n});<\/pre>\n Now, we can make an Ajax request using any jQuery method:<\/p>\n
$('.trigger').click(function() {\n $('.result').load('ajax\/test.html');\n});<\/pre>\n\t\tWhen the user clicks the button and the Ajax request completes successfully, the log message is displayed.<\/p>\n\n\n
Note:<\/strong> Because .ajaxSuccess()<\/code> is implemented as a method of jQuery object instances, we can use the this<\/code> keyword as we do here to refer to the selected elements within the callback function.<\/p>\n\n\t\tAll ajaxSuccess<\/code> handlers are invoked, regardless of what Ajax request was completed. If we must differentiate between the requests, we can use the parameters passed to the handler. Each time an ajaxSuccess<\/code> handler is executed, it is passed the event object, the XMLHttpRequest<\/code> object, and the settings object that was used in the creation of the request. For example, we can restrict our callback to only handling events dealing with a particular URL:<\/p>\n\nNote:<\/strong> You can get the returned ajax contents by looking at xhr.responseXML<\/code> or xhr.responseHTML<\/code> for xml and html respectively.<\/p>\n\n\t $('.log').ajaxSuccess(function(e, xhr, settings) {\n if (settings.url == 'ajax\/test.html') {\n $(this).text('Triggered ajaxSuccess handler. The ajax response was:' \n + xhr.responseHTML );\n }\n});<\/pre>\n ","categories":["Ajax > Global Ajax Event Handlers","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/all-selector\/","name":"all","title":"All Selector (\"*\")","type":"selector","signatures":[{"added":"1.0"}],"desc":"Selects all elements.","longdesc":"Caution: The all, or universal, selector is extremely slow, except when used by itself.<\/p> ","categories":["Selectors > Basic","Version > Version 1.0"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/andSelf\/","name":"andSelf","title":".andSelf()","type":"method","signatures":[{"added":"1.2"}],"desc":"Add the previous set of elements on the stack to the current set.","longdesc":"
As described in the discussion for .end()<\/a><\/code>, jQuery objects maintain an internal stack that keeps track of changes to the matched set of elements. When one of the DOM traversal methods is called, the new set of elements is pushed onto the stack. If the previous set of elements is desired as well, .andSelf()<\/code> can help.<\/p>\nConsider a page with a simple list on it:<\/p>\n
\n<ul>\n <li>list item 1<\/li>\n <li>list item 2<\/li>\n <li class=\"third-item\">list item 3<\/li>\n <li>list item 4<\/li>\n <li>list item 5<\/li>\n<\/ul>\n<\/pre>\nThe result of the following code is a red background behind items 3, 4 and 5:<\/p>\n
$('li.third-item').nextAll().andSelf()\n .css('background-color', 'red');\n<\/pre>\nFirst, the initial selector locates item 3, initializing the stack with the set containing just this item. The call to .nextAll()<\/code> then pushes the set of items 4 and 5 onto the stack. Finally, the .andSelf()<\/code> invocation merges these two sets together, creating a jQuery object that points to all three items in document order: {[<li.third-item>,<li>,<li> ]}<\/code>.<\/p>","categories":["Traversing > Miscellaneous Traversing","Version > Version 1.2"],"download":""},{"url":"https:\/\/web.archive.org\/web\/20111207011413\/http:\/\/api.jquery.com\/animate\/","name":"animate","title":".animate()","type":"method","signatures":[{"added":"1.0","params":[{"name":"properties","type":"Map","optional":"","desc":"A map of CSS properties that the animation will move toward."},{"name":"duration","type":"String,Number","optional":"optional","desc":"A string or number determining how long the animation will run."},{"name":"easing","type":"String","optional":"optional","desc":"A string indicating which easing function to use for the transition."},{"name":"complete","type":"Function","optional":"optional","desc":"A function to call once the animation is complete."}]},{"added":"1.0","params":[{"name":"properties","type":"Map","optional":"","desc":"A map of CSS properties that the animation will move toward."},{"name":"options","type":"Map","optional":"","desc":"A map of additional options to pass to the method. Supported keys:\n \n duration<\/code>: A string or number determining how long the animation will run.<\/li>\n easing<\/code>: A string indicating which easing function to use for the transition.<\/li>\n complete<\/code>: A function to call once the animation is complete.<\/li>\n step<\/code>: A function to be called after each step of the animation.<\/li>\n queue<\/code>: A Boolean indicating whether to place the animation in the effects queue. If false<\/code>, the animation will begin immediately. As of jQuery 1.7<\/strong>, the queue<\/code> option can also accept a string, in which case the animation is added to the queue represented by that string.<\/li>\n specialEasing<\/code>: A map of one or more of the CSS properties defined by the properties argument and their corresponding easing functions (added 1.4).<\/li>\n <\/ul>\n "}]}],"desc":"Perform a custom animation of a set of CSS properties.","longdesc":"\n The .animate()<\/code> method allows us to create animation effects on any numeric CSS property. The only required parameter is a map of CSS properties. This map is similar to the one that can be sent to the .css()<\/code> method, except that the range of properties is more restrictive.<\/p>\n\nAnimation Properties and Values<\/h4>\n
All animated properties should be animated to a single numeric value<\/em>, except as noted below; most properties that are non-numeric cannot be animated using basic jQuery functionality (For example, width<\/code>, height<\/code>, or left<\/code> can be animated but background-color<\/code> cannot be, unless the jQuery.Color()<\/a> plugin is used). Property values are treated as a number of pixels unless otherwise specified. The units em<\/code> and %<\/code> can be specified where applicable.<\/p>\nIn addition to style properties, some non-style properties such as scrollTop<\/code> and scrollLeft<\/code>, as well as custom properties, can be animated.<\/p>\nShorthand CSS properties (e.g. margin, background, border) are not supported. For example, if you want to retrieve the rendered margin, use: $(elem).css('marginTop')<\/code> and $(elem).css('marginRight')<\/code>, and so on.<\/p>\nIn addition to numeric values, each property can take the strings 'show'<\/code>, 'hide'<\/code>, and 'toggle'<\/code>. These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.<\/p>\nAnimated properties can also be relative. If a value is supplied with a leading +=<\/code> or -=<\/code> sequence of characters, then the target value is computed by adding or subtracting the given number from the current value of the property.<\/p>\nNote:<\/strong> Unlike shorthand animation methods such as .slideDown()<\/code> and .fadeIn()<\/code>, the .animate()<\/code> method does not<\/em> make hidden elements visible as part of the effect. For example, given $('someElement').hide().animate({height:'20px'}, 500)<\/code>, the animation will run, but the element will remain hidden<\/em>.<\/p><\/blockquote>\nDuration<\/h4>\n
Durations are given in milliseconds; higher values indicate slower animations, not faster ones. The strings 'fast'<\/code> and 'slow'<\/code> can be supplied to indicate durations of 200<\/code> and 600<\/code> milliseconds, respectively.<\/p>\n\nComplete Function<\/h4>\n
If supplied, the complete<\/code> callback function is fired once the animation is complete. This can be useful for stringing different animations together in sequence. The callback is not sent any arguments, but this<\/code> is set to the DOM element being animated. If multiple elements are animated, the callback is executed once per matched element, not once for the animation as a whole.<\/p>\n\nBasic Usage<\/h4>\n
To animate any element, such as a simple image:<\/p>\n
<div id=\"clickme\">\n Click here\n<\/div>\n<img id=\"book\" src=\"book.png\" alt=\"\" width=\"100\" height=\"123\"\n style=\"position: relative; left: 10px;\" \/><\/pre>\nTo animate the opacity, left offset, and height of the image simultaneously:<\/p>\n
$('#clickme').click(function() {\n $('#book').animate({\n opacity: 0.25,\n left: '+=50',\n height: 'toggle'\n }, 5000, function() {\n \/\/ Animation complete.\n });\n});\n<\/pre>\n\n 
\n<\/p>\n
Note that the target value of the height<\/code> property is