OLD | NEW |
(Empty) | |
| 1 intellisense.annotate(jQuery, { |
| 2 'ajax': function() { |
| 3 /// <signature> |
| 4 /// <summary>Perform an asynchronous HTTP (Ajax) request.</summary> |
| 5 /// <param name="url" type="String">A string containing the URL to which t
he request is sent.</param> |
| 6 /// <param name="settings" type="PlainObject">A set of key/value pairs tha
t configure the Ajax request. All settings are optional. A default can be set fo
r any option with $.ajaxSetup(). See jQuery.ajax( settings ) below for a complet
e list of all settings.</param> |
| 7 /// <returns type="jqXHR" /> |
| 8 /// </signature> |
| 9 /// <signature> |
| 10 /// <summary>Perform an asynchronous HTTP (Ajax) request.</summary> |
| 11 /// <param name="settings" type="PlainObject">A set of key/value pairs tha
t configure the Ajax request. All settings are optional. A default can be set fo
r any option with $.ajaxSetup().</param> |
| 12 /// <returns type="jqXHR" /> |
| 13 /// </signature> |
| 14 }, |
| 15 'ajaxPrefilter': function() { |
| 16 /// <signature> |
| 17 /// <summary>Handle custom Ajax options or modify existing options before
each request is sent and before they are processed by $.ajax().</summary> |
| 18 /// <param name="dataTypes" type="String">An optional string containing on
e or more space-separated dataTypes</param> |
| 19 /// <param name="handler(options, originalOptions, jqXHR)" type="Function"
>A handler to set default values for future Ajax requests.</param> |
| 20 /// </signature> |
| 21 }, |
| 22 'ajaxSetup': function() { |
| 23 /// <signature> |
| 24 /// <summary>Set default values for future Ajax requests. Its use is not r
ecommended.</summary> |
| 25 /// <param name="options" type="PlainObject">A set of key/value pairs that
configure the default Ajax request. All options are optional.</param> |
| 26 /// </signature> |
| 27 }, |
| 28 'ajaxTransport': function() { |
| 29 /// <signature> |
| 30 /// <summary>Creates an object that handles the actual transmission of Aja
x data.</summary> |
| 31 /// <param name="dataType" type="String">A string identifying the data typ
e to use</param> |
| 32 /// <param name="handler(options, originalOptions, jqXHR)" type="Function"
>A handler to return the new transport object to use with the data type provided
in the first argument.</param> |
| 33 /// </signature> |
| 34 }, |
| 35 'boxModel': function() { |
| 36 /// <summary>Deprecated in jQuery 1.3 (see jQuery.support). States if the cu
rrent page, in the user's browser, is being rendered using the W3C CSS Box Model
.</summary> |
| 37 /// <returns type="Boolean" /> |
| 38 }, |
| 39 'browser': function() { |
| 40 /// <summary>Contains flags for the useragent, read from navigator.userAgent
. This property was removed in jQuery 1.9 and is available only through the jQue
ry.migrate plugin. Please try to use feature detection instead.</summary> |
| 41 /// <returns type="PlainObject" /> |
| 42 }, |
| 43 'browser.version': function() { |
| 44 /// <summary>The version number of the rendering engine for the user's brows
er. This property was removed in jQuery 1.9 and is available only through the jQ
uery.migrate plugin.</summary> |
| 45 /// <returns type="String" /> |
| 46 }, |
| 47 'Callbacks': function() { |
| 48 /// <signature> |
| 49 /// <summary>A multi-purpose callbacks list object that provides a powerfu
l way to manage callback lists.</summary> |
| 50 /// <param name="flags" type="String">An optional list of space-separated
flags that change how the callback list behaves.</param> |
| 51 /// <returns type="Callbacks" /> |
| 52 /// </signature> |
| 53 }, |
| 54 'contains': function() { |
| 55 /// <signature> |
| 56 /// <summary>Check to see if a DOM element is a descendant of another DOM
element.</summary> |
| 57 /// <param name="container" type="Element">The DOM element that may contai
n the other element.</param> |
| 58 /// <param name="contained" type="Element">The DOM element that may be con
tained by (a descendant of) the other element.</param> |
| 59 /// <returns type="Boolean" /> |
| 60 /// </signature> |
| 61 }, |
| 62 'cssHooks': function() { |
| 63 /// <summary>Hook directly into jQuery to override how particular CSS proper
ties are retrieved or set, normalize CSS property naming, or create custom prope
rties.</summary> |
| 64 /// <returns type="Object" /> |
| 65 }, |
| 66 'data': function() { |
| 67 /// <signature> |
| 68 /// <summary>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.</summ
ary> |
| 69 /// <param name="element" type="Element">The DOM element to query for the
data.</param> |
| 70 /// <param name="key" type="String">Name of the data stored.</param> |
| 71 /// <returns type="Object" /> |
| 72 /// </signature> |
| 73 /// <signature> |
| 74 /// <summary>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.</summ
ary> |
| 75 /// <param name="element" type="Element">The DOM element to query for the
data.</param> |
| 76 /// <returns type="Object" /> |
| 77 /// </signature> |
| 78 }, |
| 79 'Deferred': function() { |
| 80 /// <signature> |
| 81 /// <summary>A constructor function that returns a chainable utility objec
t with methods to register multiple callbacks into callback queues, invoke callb
ack queues, and relay the success or failure state of any synchronous or asynchr
onous function.</summary> |
| 82 /// <param name="beforeStart" type="Function">A function that is called ju
st before the constructor returns.</param> |
| 83 /// <returns type="Deferred" /> |
| 84 /// </signature> |
| 85 }, |
| 86 'dequeue': function() { |
| 87 /// <signature> |
| 88 /// <summary>Execute the next function on the queue for the matched elemen
t.</summary> |
| 89 /// <param name="element" type="Element">A DOM element from which to remov
e and execute a queued function.</param> |
| 90 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 91 /// </signature> |
| 92 }, |
| 93 'each': function() { |
| 94 /// <signature> |
| 95 /// <summary>A generic iterator function, which can be used to seamlessly
iterate over both objects and arrays. Arrays and array-like objects with a lengt
h 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.</su
mmary> |
| 96 /// <param name="collection" type="Object">The object or array to iterate
over.</param> |
| 97 /// <param name="callback(indexInArray, valueOfElement)" type="Function">T
he function that will be executed on every object.</param> |
| 98 /// <returns type="Object" /> |
| 99 /// </signature> |
| 100 }, |
| 101 'error': function() { |
| 102 /// <signature> |
| 103 /// <summary>Takes a string and throws an exception containing it.</summar
y> |
| 104 /// <param name="message" type="String">The message to send out.</param> |
| 105 /// </signature> |
| 106 }, |
| 107 'extend': function() { |
| 108 /// <signature> |
| 109 /// <summary>Merge the contents of two or more objects together into the f
irst object.</summary> |
| 110 /// <param name="target" type="Object">An object that will receive the new
properties if additional objects are passed in or that will extend the jQuery n
amespace if it is the sole argument.</param> |
| 111 /// <param name="object1" type="Object">An object containing additional pr
operties to merge in.</param> |
| 112 /// <param name="objectN" type="Object">Additional objects containing prop
erties to merge in.</param> |
| 113 /// <returns type="Object" /> |
| 114 /// </signature> |
| 115 /// <signature> |
| 116 /// <summary>Merge the contents of two or more objects together into the f
irst object.</summary> |
| 117 /// <param name="deep" type="Boolean">If true, the merge becomes recursive
(aka. deep copy).</param> |
| 118 /// <param name="target" type="Object">The object to extend. It will recei
ve the new properties.</param> |
| 119 /// <param name="object1" type="Object">An object containing additional pr
operties to merge in.</param> |
| 120 /// <param name="objectN" type="Object">Additional objects containing prop
erties to merge in.</param> |
| 121 /// <returns type="Object" /> |
| 122 /// </signature> |
| 123 }, |
| 124 'fn.extend': function() { |
| 125 /// <signature> |
| 126 /// <summary>Merge the contents of an object onto the jQuery prototype to
provide new jQuery instance methods.</summary> |
| 127 /// <param name="object" type="Object">An object to merge onto the jQuery
prototype.</param> |
| 128 /// <returns type="Object" /> |
| 129 /// </signature> |
| 130 }, |
| 131 'get': function() { |
| 132 /// <signature> |
| 133 /// <summary>Load data from the server using a HTTP GET request.</summary> |
| 134 /// <param name="url" type="String">A string containing the URL to which t
he request is sent.</param> |
| 135 /// <param name="data" type="">A plain object or string that is sent to th
e server with the request.</param> |
| 136 /// <param name="success(data, textStatus, jqXHR)" type="Function">A callb
ack function that is executed if the request succeeds.</param> |
| 137 /// <param name="dataType" type="String">The type of data expected from th
e server. Default: Intelligent Guess (xml, json, script, or html).</param> |
| 138 /// <returns type="jqXHR" /> |
| 139 /// </signature> |
| 140 }, |
| 141 'getJSON': function() { |
| 142 /// <signature> |
| 143 /// <summary>Load JSON-encoded data from the server using a GET HTTP reque
st.</summary> |
| 144 /// <param name="url" type="String">A string containing the URL to which t
he request is sent.</param> |
| 145 /// <param name="data" type="PlainObject">A plain object or string that is
sent to the server with the request.</param> |
| 146 /// <param name="success(data, textStatus, jqXHR)" type="Function">A callb
ack function that is executed if the request succeeds.</param> |
| 147 /// <returns type="jqXHR" /> |
| 148 /// </signature> |
| 149 }, |
| 150 'getScript': function() { |
| 151 /// <signature> |
| 152 /// <summary>Load a JavaScript file from the server using a GET HTTP reque
st, then execute it.</summary> |
| 153 /// <param name="url" type="String">A string containing the URL to which t
he request is sent.</param> |
| 154 /// <param name="success(script, textStatus, jqXHR)" type="Function">A cal
lback function that is executed if the request succeeds.</param> |
| 155 /// <returns type="jqXHR" /> |
| 156 /// </signature> |
| 157 }, |
| 158 'globalEval': function() { |
| 159 /// <signature> |
| 160 /// <summary>Execute some JavaScript code globally.</summary> |
| 161 /// <param name="code" type="String">The JavaScript code to execute.</para
m> |
| 162 /// </signature> |
| 163 }, |
| 164 'grep': function() { |
| 165 /// <signature> |
| 166 /// <summary>Finds the elements of an array which satisfy a filter functio
n. The original array is not affected.</summary> |
| 167 /// <param name="array" type="Array">The array to search through.</param> |
| 168 /// <param name="function(elementOfArray, indexInArray)" type="Function">T
he 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 B
oolean value. this will be the global window object.</param> |
| 169 /// <param name="invert" type="Boolean">If "invert" is false, or not provi
ded, then the function returns an array consisting of all elements for which "ca
llback" returns true. If "invert" is true, then the function returns an array c
onsisting of all elements for which "callback" returns false.</param> |
| 170 /// <returns type="Array" /> |
| 171 /// </signature> |
| 172 }, |
| 173 'hasData': function() { |
| 174 /// <signature> |
| 175 /// <summary>Determine whether an element has any jQuery data associated w
ith it.</summary> |
| 176 /// <param name="element" type="Element">A DOM element to be checked for d
ata.</param> |
| 177 /// <returns type="Boolean" /> |
| 178 /// </signature> |
| 179 }, |
| 180 'holdReady': function() { |
| 181 /// <signature> |
| 182 /// <summary>Holds or releases the execution of jQuery's ready event.</sum
mary> |
| 183 /// <param name="hold" type="Boolean">Indicates whether the ready hold is
being requested or released</param> |
| 184 /// </signature> |
| 185 }, |
| 186 'inArray': function() { |
| 187 /// <signature> |
| 188 /// <summary>Search for a specified value within an array and return its i
ndex (or -1 if not found).</summary> |
| 189 /// <param name="value" type="Anything">The value to search for.</param> |
| 190 /// <param name="array" type="Array">An array through which to search.</pa
ram> |
| 191 /// <param name="fromIndex" type="Number">The index of the array at which
to begin the search. The default is 0, which will search the whole array.</param
> |
| 192 /// <returns type="Number" /> |
| 193 /// </signature> |
| 194 }, |
| 195 'isArray': function() { |
| 196 /// <signature> |
| 197 /// <summary>Determine whether the argument is an array.</summary> |
| 198 /// <param name="obj" type="Object">Object to test whether or not it is an
array.</param> |
| 199 /// <returns type="Boolean" /> |
| 200 /// </signature> |
| 201 }, |
| 202 'isEmptyObject': function() { |
| 203 /// <signature> |
| 204 /// <summary>Check to see if an object is empty (contains no enumerable pr
operties).</summary> |
| 205 /// <param name="object" type="Object">The object that will be checked to
see if it's empty.</param> |
| 206 /// <returns type="Boolean" /> |
| 207 /// </signature> |
| 208 }, |
| 209 'isFunction': function() { |
| 210 /// <signature> |
| 211 /// <summary>Determine if the argument passed is a Javascript function obj
ect.</summary> |
| 212 /// <param name="obj" type="PlainObject">Object to test whether or not it
is a function.</param> |
| 213 /// <returns type="Boolean" /> |
| 214 /// </signature> |
| 215 }, |
| 216 'isNumeric': function() { |
| 217 /// <signature> |
| 218 /// <summary>Determines whether its argument is a number.</summary> |
| 219 /// <param name="value" type="PlainObject">The value to be tested.</param> |
| 220 /// <returns type="Boolean" /> |
| 221 /// </signature> |
| 222 }, |
| 223 'isPlainObject': function() { |
| 224 /// <signature> |
| 225 /// <summary>Check to see if an object is a plain object (created using "{
}" or "new Object").</summary> |
| 226 /// <param name="object" type="PlainObject">The object that will be checke
d to see if it's a plain object.</param> |
| 227 /// <returns type="Boolean" /> |
| 228 /// </signature> |
| 229 }, |
| 230 'isWindow': function() { |
| 231 /// <signature> |
| 232 /// <summary>Determine whether the argument is a window.</summary> |
| 233 /// <param name="obj" type="PlainObject">Object to test whether or not it
is a window.</param> |
| 234 /// <returns type="Boolean" /> |
| 235 /// </signature> |
| 236 }, |
| 237 'isXMLDoc': function() { |
| 238 /// <signature> |
| 239 /// <summary>Check to see if a DOM node is within an XML document (or is a
n XML document).</summary> |
| 240 /// <param name="node" type="Element">The DOM node that will be checked to
see if it's in an XML document.</param> |
| 241 /// <returns type="Boolean" /> |
| 242 /// </signature> |
| 243 }, |
| 244 'makeArray': function() { |
| 245 /// <signature> |
| 246 /// <summary>Convert an array-like object into a true JavaScript array.</s
ummary> |
| 247 /// <param name="obj" type="PlainObject">Any object to turn into a native
Array.</param> |
| 248 /// <returns type="Array" /> |
| 249 /// </signature> |
| 250 }, |
| 251 'map': function() { |
| 252 /// <signature> |
| 253 /// <summary>Translate all items in an array or object to new array of ite
ms.</summary> |
| 254 /// <param name="array" type="Array">The Array to translate.</param> |
| 255 /// <param name="callback(elementOfArray, indexInArray)" type="Function">T
he 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 retu
rn any value. Within the function, this refers to the global (window) object.</p
aram> |
| 256 /// <returns type="Array" /> |
| 257 /// </signature> |
| 258 /// <signature> |
| 259 /// <summary>Translate all items in an array or object to new array of ite
ms.</summary> |
| 260 /// <param name="arrayOrObject" type="">The Array or Object to translate.<
/param> |
| 261 /// <param name="callback( value, indexOrKey )" type="Function">The functi
on to process each item against. The first argument to the function is the valu
e; 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 flat
tened into the resulting array. Within the function, this refers to the global (
window) object.</param> |
| 262 /// <returns type="Array" /> |
| 263 /// </signature> |
| 264 }, |
| 265 'merge': function() { |
| 266 /// <signature> |
| 267 /// <summary>Merge the contents of two arrays together into the first arra
y.</summary> |
| 268 /// <param name="first" type="Array">The first array to merge, the element
s of second added.</param> |
| 269 /// <param name="second" type="Array">The second array to merge into the f
irst, unaltered.</param> |
| 270 /// <returns type="Array" /> |
| 271 /// </signature> |
| 272 }, |
| 273 'noConflict': function() { |
| 274 /// <signature> |
| 275 /// <summary>Relinquish jQuery's control of the $ variable.</summary> |
| 276 /// <param name="removeAll" type="Boolean">A Boolean indicating whether to
remove all jQuery variables from the global scope (including jQuery itself).</p
aram> |
| 277 /// <returns type="Object" /> |
| 278 /// </signature> |
| 279 }, |
| 280 'noop': function() { |
| 281 /// <summary>An empty function.</summary> |
| 282 }, |
| 283 'now': function() { |
| 284 /// <summary>Return a number representing the current time.</summary> |
| 285 /// <returns type="Number" /> |
| 286 }, |
| 287 'param': function() { |
| 288 /// <signature> |
| 289 /// <summary>Create a serialized representation of an array or object, sui
table for use in a URL query string or Ajax request.</summary> |
| 290 /// <param name="obj" type="">An array or object to serialize.</param> |
| 291 /// <returns type="String" /> |
| 292 /// </signature> |
| 293 /// <signature> |
| 294 /// <summary>Create a serialized representation of an array or object, sui
table for use in a URL query string or Ajax request.</summary> |
| 295 /// <param name="obj" type="">An array or object to serialize.</param> |
| 296 /// <param name="traditional" type="Boolean">A Boolean indicating whether
to perform a traditional "shallow" serialization.</param> |
| 297 /// <returns type="String" /> |
| 298 /// </signature> |
| 299 }, |
| 300 'parseHTML': function() { |
| 301 /// <signature> |
| 302 /// <summary>Parses a string into an array of DOM nodes.</summary> |
| 303 /// <param name="data" type="String">HTML string to be parsed</param> |
| 304 /// <param name="context" type="Element">Document element to serve as the
context in which the HTML fragment will be created</param> |
| 305 /// <param name="keepScripts" type="Boolean">A Boolean indicating whether
to include scripts passed in the HTML string</param> |
| 306 /// <returns type="Array" /> |
| 307 /// </signature> |
| 308 }, |
| 309 'parseJSON': function() { |
| 310 /// <signature> |
| 311 /// <summary>Takes a well-formed JSON string and returns the resulting Jav
aScript object.</summary> |
| 312 /// <param name="json" type="String">The JSON string to parse.</param> |
| 313 /// <returns type="Object" /> |
| 314 /// </signature> |
| 315 }, |
| 316 'parseXML': function() { |
| 317 /// <signature> |
| 318 /// <summary>Parses a string into an XML document.</summary> |
| 319 /// <param name="data" type="String">a well-formed XML string to be parsed
</param> |
| 320 /// <returns type="XMLDocument" /> |
| 321 /// </signature> |
| 322 }, |
| 323 'post': function() { |
| 324 /// <signature> |
| 325 /// <summary>Load data from the server using a HTTP POST request.</summary
> |
| 326 /// <param name="url" type="String">A string containing the URL to which t
he request is sent.</param> |
| 327 /// <param name="data" type="">A plain object or string that is sent to th
e server with the request.</param> |
| 328 /// <param name="success(data, textStatus, jqXHR)" type="Function">A callb
ack function that is executed if the request succeeds. Required if dataType is p
rovided, but can be null in that case.</param> |
| 329 /// <param name="dataType" type="String">The type of data expected from th
e server. Default: Intelligent Guess (xml, json, script, text, html).</param> |
| 330 /// <returns type="jqXHR" /> |
| 331 /// </signature> |
| 332 }, |
| 333 'proxy': function() { |
| 334 /// <signature> |
| 335 /// <summary>Takes a function and returns a new one that will always have
a particular context.</summary> |
| 336 /// <param name="function" type="Function">The function whose context will
be changed.</param> |
| 337 /// <param name="context" type="PlainObject">The object to which the conte
xt (this) of the function should be set.</param> |
| 338 /// <returns type="Function" /> |
| 339 /// </signature> |
| 340 /// <signature> |
| 341 /// <summary>Takes a function and returns a new one that will always have
a particular context.</summary> |
| 342 /// <param name="context" type="PlainObject">The object to which the conte
xt of the function should be set.</param> |
| 343 /// <param name="name" type="String">The name of the function whose contex
t will be changed (should be a property of the context object).</param> |
| 344 /// <returns type="Function" /> |
| 345 /// </signature> |
| 346 /// <signature> |
| 347 /// <summary>Takes a function and returns a new one that will always have
a particular context.</summary> |
| 348 /// <param name="function" type="Function">The function whose context will
be changed.</param> |
| 349 /// <param name="context" type="PlainObject">The object to which the conte
xt (this) of the function should be set.</param> |
| 350 /// <param name="additionalArguments" type="Anything">Any number of argume
nts to be passed to the function referenced in the function argument.</param> |
| 351 /// <returns type="Function" /> |
| 352 /// </signature> |
| 353 /// <signature> |
| 354 /// <summary>Takes a function and returns a new one that will always have
a particular context.</summary> |
| 355 /// <param name="context" type="PlainObject">The object to which the conte
xt of the function should be set.</param> |
| 356 /// <param name="name" type="String">The name of the function whose contex
t will be changed (should be a property of the context object).</param> |
| 357 /// <param name="additionalArguments" type="Anything">Any number of argume
nts to be passed to the function named in the name argument.</param> |
| 358 /// <returns type="Function" /> |
| 359 /// </signature> |
| 360 }, |
| 361 'queue': function() { |
| 362 /// <signature> |
| 363 /// <summary>Manipulate the queue of functions to be executed on the match
ed element.</summary> |
| 364 /// <param name="element" type="Element">A DOM element where the array of
queued functions is attached.</param> |
| 365 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 366 /// <param name="newQueue" type="Array">An array of functions to replace t
he current queue contents.</param> |
| 367 /// <returns type="jQuery" /> |
| 368 /// </signature> |
| 369 /// <signature> |
| 370 /// <summary>Manipulate the queue of functions to be executed on the match
ed element.</summary> |
| 371 /// <param name="element" type="Element">A DOM element on which to add a q
ueued function.</param> |
| 372 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 373 /// <param name="callback()" type="Function">The new function to add to th
e queue.</param> |
| 374 /// <returns type="jQuery" /> |
| 375 /// </signature> |
| 376 }, |
| 377 'removeData': function() { |
| 378 /// <signature> |
| 379 /// <summary>Remove a previously-stored piece of data.</summary> |
| 380 /// <param name="element" type="Element">A DOM element from which to remov
e data.</param> |
| 381 /// <param name="name" type="String">A string naming the piece of data to
remove.</param> |
| 382 /// <returns type="jQuery" /> |
| 383 /// </signature> |
| 384 }, |
| 385 'sub': function() { |
| 386 /// <summary>Creates a new copy of jQuery whose properties and methods can b
e modified without affecting the original jQuery object.</summary> |
| 387 /// <returns type="jQuery" /> |
| 388 }, |
| 389 'support': function() { |
| 390 /// <summary>A collection of properties that represent the presence of diffe
rent browser features or bugs. Primarily intended for jQuery's internal use; spe
cific properties may be removed when they are no longer needed internally to imp
rove page startup performance.</summary> |
| 391 /// <returns type="Object" /> |
| 392 }, |
| 393 'trim': function() { |
| 394 /// <signature> |
| 395 /// <summary>Remove the whitespace from the beginning and end of a string.
</summary> |
| 396 /// <param name="str" type="String">The string to trim.</param> |
| 397 /// <returns type="String" /> |
| 398 /// </signature> |
| 399 }, |
| 400 'type': function() { |
| 401 /// <signature> |
| 402 /// <summary>Determine the internal JavaScript [[Class]] of an object.</su
mmary> |
| 403 /// <param name="obj" type="PlainObject">Object to get the internal JavaSc
ript [[Class]] of.</param> |
| 404 /// <returns type="String" /> |
| 405 /// </signature> |
| 406 }, |
| 407 'unique': function() { |
| 408 /// <signature> |
| 409 /// <summary>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 nu
mbers.</summary> |
| 410 /// <param name="array" type="Array">The Array of DOM elements.</param> |
| 411 /// <returns type="Array" /> |
| 412 /// </signature> |
| 413 }, |
| 414 'when': function() { |
| 415 /// <signature> |
| 416 /// <summary>Provides a way to execute callback functions based on one or
more objects, usually Deferred objects that represent asynchronous events.</summ
ary> |
| 417 /// <param name="deferreds" type="Deferred">One or more Deferred objects,
or plain JavaScript objects.</param> |
| 418 /// <returns type="Promise" /> |
| 419 /// </signature> |
| 420 }, |
| 421 }); |
| 422 |
| 423 var _1228819969 = jQuery.Callbacks; |
| 424 jQuery.Callbacks = function(flags) { |
| 425 var _object = _1228819969(flags); |
| 426 intellisense.annotate(_object, { |
| 427 'add': function() { |
| 428 /// <signature> |
| 429 /// <summary>Add a callback or a collection of callbacks to a callback lis
t.</summary> |
| 430 /// <param name="callbacks" type="">A function, or array of functions, tha
t are to be added to the callback list.</param> |
| 431 /// <returns type="Callbacks" /> |
| 432 /// </signature> |
| 433 }, |
| 434 'disable': function() { |
| 435 /// <summary>Disable a callback list from doing anything more.</summary> |
| 436 /// <returns type="Callbacks" /> |
| 437 }, |
| 438 'disabled': function() { |
| 439 /// <summary>Determine if the callbacks list has been disabled.</summary> |
| 440 /// <returns type="Boolean" /> |
| 441 }, |
| 442 'empty': function() { |
| 443 /// <summary>Remove all of the callbacks from a list.</summary> |
| 444 /// <returns type="Callbacks" /> |
| 445 }, |
| 446 'fire': function() { |
| 447 /// <signature> |
| 448 /// <summary>Call all of the callbacks with the given arguments</summary> |
| 449 /// <param name="arguments" type="Anything">The argument or list of argume
nts to pass back to the callback list.</param> |
| 450 /// <returns type="Callbacks" /> |
| 451 /// </signature> |
| 452 }, |
| 453 'fired': function() { |
| 454 /// <summary>Determine if the callbacks have already been called at least on
ce.</summary> |
| 455 /// <returns type="Boolean" /> |
| 456 }, |
| 457 'fireWith': function() { |
| 458 /// <signature> |
| 459 /// <summary>Call all callbacks in a list with the given context and argum
ents.</summary> |
| 460 /// <param name="context" type="">A reference to the context in which the
callbacks in the list should be fired.</param> |
| 461 /// <param name="args" type="">An argument, or array of arguments, to pass
to the callbacks in the list.</param> |
| 462 /// <returns type="Callbacks" /> |
| 463 /// </signature> |
| 464 }, |
| 465 'has': function() { |
| 466 /// <signature> |
| 467 /// <summary>Determine whether a supplied callback is in a list</summary> |
| 468 /// <param name="callback" type="Function">The callback to search for.</pa
ram> |
| 469 /// <returns type="Boolean" /> |
| 470 /// </signature> |
| 471 }, |
| 472 'lock': function() { |
| 473 /// <summary>Lock a callback list in its current state.</summary> |
| 474 /// <returns type="Callbacks" /> |
| 475 }, |
| 476 'locked': function() { |
| 477 /// <summary>Determine if the callbacks list has been locked.</summary> |
| 478 /// <returns type="Boolean" /> |
| 479 }, |
| 480 'remove': function() { |
| 481 /// <signature> |
| 482 /// <summary>Remove a callback or a collection of callbacks from a callbac
k list.</summary> |
| 483 /// <param name="callbacks" type="">A function, or array of functions, tha
t are to be removed from the callback list.</param> |
| 484 /// <returns type="Callbacks" /> |
| 485 /// </signature> |
| 486 }, |
| 487 }); |
| 488 |
| 489 return _object; |
| 490 }; |
| 491 intellisense.redirectDefinition(jQuery.Callbacks, _1228819969); |
| 492 |
| 493 var _731531622 = jQuery.Deferred; |
| 494 jQuery.Deferred = function(func) { |
| 495 var _object = _731531622(func); |
| 496 intellisense.annotate(_object, { |
| 497 'always': function() { |
| 498 /// <signature> |
| 499 /// <summary>Add handlers to be called when the Deferred object is either
resolved or rejected.</summary> |
| 500 /// <param name="alwaysCallbacks" type="Function">A function, or array of
functions, that is called when the Deferred is resolved or rejected.</param> |
| 501 /// <param name="alwaysCallbacks" type="Function">Optional additional func
tions, or arrays of functions, that are called when the Deferred is resolved or
rejected.</param> |
| 502 /// <returns type="Deferred" /> |
| 503 /// </signature> |
| 504 }, |
| 505 'done': function() { |
| 506 /// <signature> |
| 507 /// <summary>Add handlers to be called when the Deferred object is resolve
d.</summary> |
| 508 /// <param name="doneCallbacks" type="Function">A function, or array of fu
nctions, that are called when the Deferred is resolved.</param> |
| 509 /// <param name="doneCallbacks" type="Function">Optional additional functi
ons, or arrays of functions, that are called when the Deferred is resolved.</par
am> |
| 510 /// <returns type="Deferred" /> |
| 511 /// </signature> |
| 512 }, |
| 513 'fail': function() { |
| 514 /// <signature> |
| 515 /// <summary>Add handlers to be called when the Deferred object is rejecte
d.</summary> |
| 516 /// <param name="failCallbacks" type="Function">A function, or array of fu
nctions, that are called when the Deferred is rejected.</param> |
| 517 /// <param name="failCallbacks" type="Function">Optional additional functi
ons, or arrays of functions, that are called when the Deferred is rejected.</par
am> |
| 518 /// <returns type="Deferred" /> |
| 519 /// </signature> |
| 520 }, |
| 521 'isRejected': function() { |
| 522 /// <summary>Determine whether a Deferred object has been rejected.</summary
> |
| 523 /// <returns type="Boolean" /> |
| 524 }, |
| 525 'isResolved': function() { |
| 526 /// <summary>Determine whether a Deferred object has been resolved.</summary
> |
| 527 /// <returns type="Boolean" /> |
| 528 }, |
| 529 'notify': function() { |
| 530 /// <signature> |
| 531 /// <summary>Call the progressCallbacks on a Deferred object with the give
n args.</summary> |
| 532 /// <param name="args" type="Object">Optional arguments that are passed to
the progressCallbacks.</param> |
| 533 /// <returns type="Deferred" /> |
| 534 /// </signature> |
| 535 }, |
| 536 'notifyWith': function() { |
| 537 /// <signature> |
| 538 /// <summary>Call the progressCallbacks on a Deferred object with the give
n context and args.</summary> |
| 539 /// <param name="context" type="Object">Context passed to the progressCall
backs as the this object.</param> |
| 540 /// <param name="args" type="Object">Optional arguments that are passed to
the progressCallbacks.</param> |
| 541 /// <returns type="Deferred" /> |
| 542 /// </signature> |
| 543 }, |
| 544 'pipe': function() { |
| 545 /// <signature> |
| 546 /// <summary>Utility method to filter and/or chain Deferreds.</summary> |
| 547 /// <param name="doneFilter" type="Function">An optional function that is
called when the Deferred is resolved.</param> |
| 548 /// <param name="failFilter" type="Function">An optional function that is
called when the Deferred is rejected.</param> |
| 549 /// <returns type="Promise" /> |
| 550 /// </signature> |
| 551 /// <signature> |
| 552 /// <summary>Utility method to filter and/or chain Deferreds.</summary> |
| 553 /// <param name="doneFilter" type="Function">An optional function that is
called when the Deferred is resolved.</param> |
| 554 /// <param name="failFilter" type="Function">An optional function that is
called when the Deferred is rejected.</param> |
| 555 /// <param name="progressFilter" type="Function">An optional function that
is called when progress notifications are sent to the Deferred.</param> |
| 556 /// <returns type="Promise" /> |
| 557 /// </signature> |
| 558 }, |
| 559 'progress': function() { |
| 560 /// <signature> |
| 561 /// <summary>Add handlers to be called when the Deferred object generates
progress notifications.</summary> |
| 562 /// <param name="progressCallbacks" type="">A function, or array of functi
ons, to be called when the Deferred generates progress notifications.</param> |
| 563 /// <returns type="Deferred" /> |
| 564 /// </signature> |
| 565 }, |
| 566 'promise': function() { |
| 567 /// <signature> |
| 568 /// <summary>Return a Deferred's Promise object.</summary> |
| 569 /// <param name="target" type="Object">Object onto which the promise metho
ds have to be attached</param> |
| 570 /// <returns type="Promise" /> |
| 571 /// </signature> |
| 572 }, |
| 573 'reject': function() { |
| 574 /// <signature> |
| 575 /// <summary>Reject a Deferred object and call any failCallbacks with the
given args.</summary> |
| 576 /// <param name="args" type="Anything">Optional arguments that are passed
to the failCallbacks.</param> |
| 577 /// <returns type="Deferred" /> |
| 578 /// </signature> |
| 579 }, |
| 580 'rejectWith': function() { |
| 581 /// <signature> |
| 582 /// <summary>Reject a Deferred object and call any failCallbacks with the
given context and args.</summary> |
| 583 /// <param name="context" type="Object">Context passed to the failCallback
s as the this object.</param> |
| 584 /// <param name="args" type="Array">An optional array of arguments that ar
e passed to the failCallbacks.</param> |
| 585 /// <returns type="Deferred" /> |
| 586 /// </signature> |
| 587 }, |
| 588 'resolve': function() { |
| 589 /// <signature> |
| 590 /// <summary>Resolve a Deferred object and call any doneCallbacks with the
given args.</summary> |
| 591 /// <param name="args" type="Anything">Optional arguments that are passed
to the doneCallbacks.</param> |
| 592 /// <returns type="Deferred" /> |
| 593 /// </signature> |
| 594 }, |
| 595 'resolveWith': function() { |
| 596 /// <signature> |
| 597 /// <summary>Resolve a Deferred object and call any doneCallbacks with the
given context and args.</summary> |
| 598 /// <param name="context" type="Object">Context passed to the doneCallback
s as the this object.</param> |
| 599 /// <param name="args" type="Array">An optional array of arguments that ar
e passed to the doneCallbacks.</param> |
| 600 /// <returns type="Deferred" /> |
| 601 /// </signature> |
| 602 }, |
| 603 'state': function() { |
| 604 /// <summary>Determine the current state of a Deferred object.</summary> |
| 605 /// <returns type="String" /> |
| 606 }, |
| 607 'then': function() { |
| 608 /// <signature> |
| 609 /// <summary>Add handlers to be called when the Deferred object is resolve
d, rejected, or still in progress.</summary> |
| 610 /// <param name="doneFilter" type="Function">A function that is called whe
n the Deferred is resolved.</param> |
| 611 /// <param name="failFilter" type="Function">An optional function that is
called when the Deferred is rejected.</param> |
| 612 /// <param name="progressFilter" type="Function">An optional function that
is called when progress notifications are sent to the Deferred.</param> |
| 613 /// <returns type="Promise" /> |
| 614 /// </signature> |
| 615 /// <signature> |
| 616 /// <summary>Add handlers to be called when the Deferred object is resolve
d, rejected, or still in progress.</summary> |
| 617 /// <param name="doneCallbacks" type="Function">A function, or array of fu
nctions, called when the Deferred is resolved.</param> |
| 618 /// <param name="failCallbacks" type="Function">A function, or array of fu
nctions, called when the Deferred is rejected.</param> |
| 619 /// <returns type="Promise" /> |
| 620 /// </signature> |
| 621 /// <signature> |
| 622 /// <summary>Add handlers to be called when the Deferred object is resolve
d, rejected, or still in progress.</summary> |
| 623 /// <param name="doneCallbacks" type="Function">A function, or array of fu
nctions, called when the Deferred is resolved.</param> |
| 624 /// <param name="failCallbacks" type="Function">A function, or array of fu
nctions, called when the Deferred is rejected.</param> |
| 625 /// <param name="progressCallbacks" type="Function">A function, or array o
f functions, called when the Deferred notifies progress.</param> |
| 626 /// <returns type="Promise" /> |
| 627 /// </signature> |
| 628 }, |
| 629 }); |
| 630 |
| 631 return _object; |
| 632 }; |
| 633 intellisense.redirectDefinition(jQuery.Callbacks, _731531622); |
| 634 |
| 635 intellisense.annotate(jQuery.Event.prototype, { |
| 636 'currentTarget': function() { |
| 637 /// <summary>The current DOM element within the event bubbling phase.</summa
ry> |
| 638 /// <returns type="Element" /> |
| 639 }, |
| 640 'data': function() { |
| 641 /// <summary>An optional object of data passed to an event method when the c
urrent executing handler is bound.</summary> |
| 642 /// <returns type="Object" /> |
| 643 }, |
| 644 'delegateTarget': function() { |
| 645 /// <summary>The element where the currently-called jQuery event handler was
attached.</summary> |
| 646 /// <returns type="Element" /> |
| 647 }, |
| 648 'isDefaultPrevented': function() { |
| 649 /// <summary>Returns whether event.preventDefault() was ever called on this
event object.</summary> |
| 650 /// <returns type="Boolean" /> |
| 651 }, |
| 652 'isImmediatePropagationStopped': function() { |
| 653 /// <summary>Returns whether event.stopImmediatePropagation() was ever calle
d on this event object.</summary> |
| 654 /// <returns type="Boolean" /> |
| 655 }, |
| 656 'isPropagationStopped': function() { |
| 657 /// <summary>Returns whether event.stopPropagation() was ever called on this
event object.</summary> |
| 658 /// <returns type="Boolean" /> |
| 659 }, |
| 660 'metaKey': function() { |
| 661 /// <summary>Indicates whether the META key was pressed when the event fired
.</summary> |
| 662 /// <returns type="Boolean" /> |
| 663 }, |
| 664 'namespace': function() { |
| 665 /// <summary>The namespace specified when the event was triggered.</summary> |
| 666 /// <returns type="String" /> |
| 667 }, |
| 668 'pageX': function() { |
| 669 /// <summary>The mouse position relative to the left edge of the document.</
summary> |
| 670 /// <returns type="Number" /> |
| 671 }, |
| 672 'pageY': function() { |
| 673 /// <summary>The mouse position relative to the top edge of the document.</s
ummary> |
| 674 /// <returns type="Number" /> |
| 675 }, |
| 676 'preventDefault': function() { |
| 677 /// <summary>If this method is called, the default action of the event will
not be triggered.</summary> |
| 678 }, |
| 679 'relatedTarget': function() { |
| 680 /// <summary>The other DOM element involved in the event, if any.</summary> |
| 681 /// <returns type="Element" /> |
| 682 }, |
| 683 'result': function() { |
| 684 /// <summary>The last value returned by an event handler that was triggered
by this event, unless the value was undefined.</summary> |
| 685 /// <returns type="Object" /> |
| 686 }, |
| 687 'stopImmediatePropagation': function() { |
| 688 /// <summary>Keeps the rest of the handlers from being executed and prevents
the event from bubbling up the DOM tree.</summary> |
| 689 }, |
| 690 'stopPropagation': function() { |
| 691 /// <summary>Prevents the event from bubbling up the DOM tree, preventing an
y parent handlers from being notified of the event.</summary> |
| 692 }, |
| 693 'target': function() { |
| 694 /// <summary>The DOM element that initiated the event.</summary> |
| 695 /// <returns type="Element" /> |
| 696 }, |
| 697 'timeStamp': function() { |
| 698 /// <summary>The difference in milliseconds between the time the browser cre
ated the event and January 1, 1970.</summary> |
| 699 /// <returns type="Number" /> |
| 700 }, |
| 701 'type': function() { |
| 702 /// <summary>Describes the nature of the event.</summary> |
| 703 /// <returns type="String" /> |
| 704 }, |
| 705 'which': function() { |
| 706 /// <summary>For key or mouse events, this property indicates the specific k
ey or button that was pressed.</summary> |
| 707 /// <returns type="Number" /> |
| 708 }, |
| 709 }); |
| 710 |
| 711 intellisense.annotate(jQuery.fn, { |
| 712 'add': function() { |
| 713 /// <signature> |
| 714 /// <summary>Add elements to the set of matched elements.</summary> |
| 715 /// <param name="selector" type="String">A string representing a selector
expression to find additional elements to add to the set of matched elements.</p
aram> |
| 716 /// <returns type="jQuery" /> |
| 717 /// </signature> |
| 718 /// <signature> |
| 719 /// <summary>Add elements to the set of matched elements.</summary> |
| 720 /// <param name="elements" type="Array">One or more elements to add to the
set of matched elements.</param> |
| 721 /// <returns type="jQuery" /> |
| 722 /// </signature> |
| 723 /// <signature> |
| 724 /// <summary>Add elements to the set of matched elements.</summary> |
| 725 /// <param name="html" type="htmlString">An HTML fragment to add to the se
t of matched elements.</param> |
| 726 /// <returns type="jQuery" /> |
| 727 /// </signature> |
| 728 /// <signature> |
| 729 /// <summary>Add elements to the set of matched elements.</summary> |
| 730 /// <param name="jQuery object" type="jQuery object ">An existing jQuery o
bject to add to the set of matched elements.</param> |
| 731 /// <returns type="jQuery" /> |
| 732 /// </signature> |
| 733 /// <signature> |
| 734 /// <summary>Add elements to the set of matched elements.</summary> |
| 735 /// <param name="selector" type="String">A string representing a selector
expression to find additional elements to add to the set of matched elements.</p
aram> |
| 736 /// <param name="context" type="Element">The point in the document at whic
h the selector should begin matching; similar to the context argument of the $(s
elector, context) method.</param> |
| 737 /// <returns type="jQuery" /> |
| 738 /// </signature> |
| 739 }, |
| 740 'addBack': function() { |
| 741 /// <signature> |
| 742 /// <summary>Add the previous set of elements on the stack to the current
set, optionally filtered by a selector.</summary> |
| 743 /// <param name="selector" type="String">A string containing a selector ex
pression to match the current set of elements against.</param> |
| 744 /// <returns type="jQuery" /> |
| 745 /// </signature> |
| 746 }, |
| 747 'addClass': function() { |
| 748 /// <signature> |
| 749 /// <summary>Adds the specified class(es) to each of the set of matched el
ements.</summary> |
| 750 /// <param name="className" type="String">One or more space-separated clas
ses to be added to the class attribute of each matched element.</param> |
| 751 /// <returns type="jQuery" /> |
| 752 /// </signature> |
| 753 /// <signature> |
| 754 /// <summary>Adds the specified class(es) to each of the set of matched el
ements.</summary> |
| 755 /// <param name="function(index, currentClass)" type="Function">A function
returning one or more space-separated class names to be added to the existing c
lass name(s). Receives the index position of the element in the set and the exis
ting class name(s) as arguments. Within the function, this refers to the current
element in the set.</param> |
| 756 /// <returns type="jQuery" /> |
| 757 /// </signature> |
| 758 }, |
| 759 'after': function() { |
| 760 /// <signature> |
| 761 /// <summary>Insert content, specified by the parameter, after each elemen
t in the set of matched elements.</summary> |
| 762 /// <param name="content" type="">HTML string, DOM element, or jQuery obje
ct to insert after each element in the set of matched elements.</param> |
| 763 /// <param name="content" type="">One or more additional DOM elements, arr
ays of elements, HTML strings, or jQuery objects to insert after each element in
the set of matched elements.</param> |
| 764 /// <returns type="jQuery" /> |
| 765 /// </signature> |
| 766 /// <signature> |
| 767 /// <summary>Insert content, specified by the parameter, after each elemen
t in the set of matched elements.</summary> |
| 768 /// <param name="function(index)" type="Function">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 t
he set.</param> |
| 769 /// <returns type="jQuery" /> |
| 770 /// </signature> |
| 771 }, |
| 772 'ajaxComplete': function() { |
| 773 /// <signature> |
| 774 /// <summary>Register a handler to be called when Ajax requests complete.
This is an AjaxEvent.</summary> |
| 775 /// <param name="handler(event, XMLHttpRequest, ajaxOptions)" type="Functi
on">The function to be invoked.</param> |
| 776 /// <returns type="jQuery" /> |
| 777 /// </signature> |
| 778 }, |
| 779 'ajaxError': function() { |
| 780 /// <signature> |
| 781 /// <summary>Register a handler to be called when Ajax requests complete w
ith an error. This is an Ajax Event.</summary> |
| 782 /// <param name="handler(event, jqXHR, ajaxSettings, thrownError)" type="F
unction">The function to be invoked.</param> |
| 783 /// <returns type="jQuery" /> |
| 784 /// </signature> |
| 785 }, |
| 786 'ajaxSend': function() { |
| 787 /// <signature> |
| 788 /// <summary>Attach a function to be executed before an Ajax request is se
nt. This is an Ajax Event.</summary> |
| 789 /// <param name="handler(event, jqXHR, ajaxOptions)" type="Function">The f
unction to be invoked.</param> |
| 790 /// <returns type="jQuery" /> |
| 791 /// </signature> |
| 792 }, |
| 793 'ajaxStart': function() { |
| 794 /// <signature> |
| 795 /// <summary>Register a handler to be called when the first Ajax request b
egins. This is an Ajax Event.</summary> |
| 796 /// <param name="handler()" type="Function">The function to be invoked.</p
aram> |
| 797 /// <returns type="jQuery" /> |
| 798 /// </signature> |
| 799 }, |
| 800 'ajaxStop': function() { |
| 801 /// <signature> |
| 802 /// <summary>Register a handler to be called when all Ajax requests have c
ompleted. This is an Ajax Event.</summary> |
| 803 /// <param name="handler()" type="Function">The function to be invoked.</p
aram> |
| 804 /// <returns type="jQuery" /> |
| 805 /// </signature> |
| 806 }, |
| 807 'ajaxSuccess': function() { |
| 808 /// <signature> |
| 809 /// <summary>Attach a function to be executed whenever an Ajax request com
pletes successfully. This is an Ajax Event.</summary> |
| 810 /// <param name="handler(event, XMLHttpRequest, ajaxOptions)" type="Functi
on">The function to be invoked.</param> |
| 811 /// <returns type="jQuery" /> |
| 812 /// </signature> |
| 813 }, |
| 814 'all': function() { |
| 815 /// <summary>Selects all elements.</summary> |
| 816 }, |
| 817 'andSelf': function() { |
| 818 /// <summary>Add the previous set of elements on the stack to the current se
t.</summary> |
| 819 /// <returns type="jQuery" /> |
| 820 }, |
| 821 'animate': function() { |
| 822 /// <signature> |
| 823 /// <summary>Perform a custom animation of a set of CSS properties.</summa
ry> |
| 824 /// <param name="properties" type="PlainObject">An object of CSS propertie
s and values that the animation will move toward.</param> |
| 825 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 826 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 827 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 828 /// <returns type="jQuery" /> |
| 829 /// </signature> |
| 830 /// <signature> |
| 831 /// <summary>Perform a custom animation of a set of CSS properties.</summa
ry> |
| 832 /// <param name="properties" type="PlainObject">An object of CSS propertie
s and values that the animation will move toward.</param> |
| 833 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 834 /// <returns type="jQuery" /> |
| 835 /// </signature> |
| 836 }, |
| 837 'animated': function() { |
| 838 /// <summary>Select all elements that are in the progress of an animation at
the time the selector is run.</summary> |
| 839 }, |
| 840 'append': function() { |
| 841 /// <signature> |
| 842 /// <summary>Insert content, specified by the parameter, to the end of eac
h element in the set of matched elements.</summary> |
| 843 /// <param name="content" type="">DOM element, HTML string, or jQuery obje
ct to insert at the end of each element in the set of matched elements.</param> |
| 844 /// <param name="content" type="">One or more additional DOM elements, arr
ays of elements, HTML strings, or jQuery objects to insert at the end of each el
ement in the set of matched elements.</param> |
| 845 /// <returns type="jQuery" /> |
| 846 /// </signature> |
| 847 /// <signature> |
| 848 /// <summary>Insert content, specified by the parameter, to the end of eac
h element in the set of matched elements.</summary> |
| 849 /// <param name="function(index, html)" type="Function">A function that re
turns an HTML string, DOM element(s), or jQuery object to insert at the end of e
ach element in the set of matched elements. Receives the index position of the e
lement 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.</param> |
| 850 /// <returns type="jQuery" /> |
| 851 /// </signature> |
| 852 }, |
| 853 'appendTo': function() { |
| 854 /// <signature> |
| 855 /// <summary>Insert every element in the set of matched elements to the en
d of the target.</summary> |
| 856 /// <param name="target" type="">A selector, element, HTML string, or jQue
ry object; the matched set of elements will be inserted at the end of the elemen
t(s) specified by this parameter.</param> |
| 857 /// <returns type="jQuery" /> |
| 858 /// </signature> |
| 859 }, |
| 860 'attr': function() { |
| 861 /// <signature> |
| 862 /// <summary>Set one or more attributes for the set of matched elements.</
summary> |
| 863 /// <param name="attributeName" type="String">The name of the attribute to
set.</param> |
| 864 /// <param name="value" type="">A value to set for the attribute.</param> |
| 865 /// <returns type="jQuery" /> |
| 866 /// </signature> |
| 867 /// <signature> |
| 868 /// <summary>Set one or more attributes for the set of matched elements.</
summary> |
| 869 /// <param name="attributes" type="PlainObject">An object of attribute-val
ue pairs to set.</param> |
| 870 /// <returns type="jQuery" /> |
| 871 /// </signature> |
| 872 /// <signature> |
| 873 /// <summary>Set one or more attributes for the set of matched elements.</
summary> |
| 874 /// <param name="attributeName" type="String">The name of the attribute to
set.</param> |
| 875 /// <param name="function(index, attr)" type="Function">A function returni
ng 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.</param> |
| 876 /// <returns type="jQuery" /> |
| 877 /// </signature> |
| 878 }, |
| 879 'attributeContains': function() { |
| 880 /// <signature> |
| 881 /// <summary>Selects elements that have the specified attribute with a val
ue containing the a given substring.</summary> |
| 882 /// <param name="attribute" type="String">An attribute name.</param> |
| 883 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 884 /// </signature> |
| 885 }, |
| 886 'attributeContainsPrefix': function() { |
| 887 /// <signature> |
| 888 /// <summary>Selects elements that have the specified attribute with a val
ue either equal to a given string or starting with that string followed by a hyp
hen (-).</summary> |
| 889 /// <param name="attribute" type="String">An attribute name.</param> |
| 890 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 891 /// </signature> |
| 892 }, |
| 893 'attributeContainsWord': function() { |
| 894 /// <signature> |
| 895 /// <summary>Selects elements that have the specified attribute with a val
ue containing a given word, delimited by spaces.</summary> |
| 896 /// <param name="attribute" type="String">An attribute name.</param> |
| 897 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 898 /// </signature> |
| 899 }, |
| 900 'attributeEndsWith': function() { |
| 901 /// <signature> |
| 902 /// <summary>Selects elements that have the specified attribute with a val
ue ending exactly with a given string. The comparison is case sensitive.</summar
y> |
| 903 /// <param name="attribute" type="String">An attribute name.</param> |
| 904 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 905 /// </signature> |
| 906 }, |
| 907 'attributeEquals': function() { |
| 908 /// <signature> |
| 909 /// <summary>Selects elements that have the specified attribute with a val
ue exactly equal to a certain value.</summary> |
| 910 /// <param name="attribute" type="String">An attribute name.</param> |
| 911 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 912 /// </signature> |
| 913 }, |
| 914 'attributeHas': function() { |
| 915 /// <signature> |
| 916 /// <summary>Selects elements that have the specified attribute, with any
value.</summary> |
| 917 /// <param name="attribute" type="String">An attribute name.</param> |
| 918 /// </signature> |
| 919 }, |
| 920 'attributeMultiple': function() { |
| 921 /// <signature> |
| 922 /// <summary>Matches elements that match all of the specified attribute fi
lters.</summary> |
| 923 /// <param name="attributeFilter1" type="String">An attribute filter.</par
am> |
| 924 /// <param name="attributeFilter2" type="String">Another attribute filter,
reducing the selection even more</param> |
| 925 /// <param name="attributeFilterN" type="String">As many more attribute fi
lters as necessary</param> |
| 926 /// </signature> |
| 927 }, |
| 928 'attributeNotEqual': function() { |
| 929 /// <signature> |
| 930 /// <summary>Select elements that either don't have the specified attribut
e, or do have the specified attribute but not with a certain value.</summary> |
| 931 /// <param name="attribute" type="String">An attribute name.</param> |
| 932 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 933 /// </signature> |
| 934 }, |
| 935 'attributeStartsWith': function() { |
| 936 /// <signature> |
| 937 /// <summary>Selects elements that have the specified attribute with a val
ue beginning exactly with a given string.</summary> |
| 938 /// <param name="attribute" type="String">An attribute name.</param> |
| 939 /// <param name="value" type="String">An attribute value. Can be either an
unquoted single word or a quoted string.</param> |
| 940 /// </signature> |
| 941 }, |
| 942 'before': function() { |
| 943 /// <signature> |
| 944 /// <summary>Insert content, specified by the parameter, before each eleme
nt in the set of matched elements.</summary> |
| 945 /// <param name="content" type="">HTML string, DOM element, or jQuery obje
ct to insert before each element in the set of matched elements.</param> |
| 946 /// <param name="content" type="">One or more additional DOM elements, arr
ays of elements, HTML strings, or jQuery objects to insert before each element i
n the set of matched elements.</param> |
| 947 /// <returns type="jQuery" /> |
| 948 /// </signature> |
| 949 /// <signature> |
| 950 /// <summary>Insert content, specified by the parameter, before each eleme
nt in the set of matched elements.</summary> |
| 951 /// <param name="function" type="Function">A function that returns an HTML
string, DOM element(s), or jQuery object to insert before each element in the s
et 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
.</param> |
| 952 /// <returns type="jQuery" /> |
| 953 /// </signature> |
| 954 }, |
| 955 'bind': function() { |
| 956 /// <signature> |
| 957 /// <summary>Attach a handler to an event for the elements.</summary> |
| 958 /// <param name="eventType" type="String">A string containing one or more
DOM event types, such as "click" or "submit," or custom event names.</param> |
| 959 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 960 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 961 /// <returns type="jQuery" /> |
| 962 /// </signature> |
| 963 /// <signature> |
| 964 /// <summary>Attach a handler to an event for the elements.</summary> |
| 965 /// <param name="eventType" type="String">A string containing one or more
DOM event types, such as "click" or "submit," or custom event names.</param> |
| 966 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 967 /// <param name="preventBubble" type="Boolean">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.</param> |
| 968 /// <returns type="jQuery" /> |
| 969 /// </signature> |
| 970 /// <signature> |
| 971 /// <summary>Attach a handler to an event for the elements.</summary> |
| 972 /// <param name="events" type="Object">An object containing one or more DO
M event types and functions to execute for them.</param> |
| 973 /// <returns type="jQuery" /> |
| 974 /// </signature> |
| 975 }, |
| 976 'blur': function() { |
| 977 /// <signature> |
| 978 /// <summary>Bind an event handler to the "blur" JavaScript event, or trig
ger that event on an element.</summary> |
| 979 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 980 /// <returns type="jQuery" /> |
| 981 /// </signature> |
| 982 /// <signature> |
| 983 /// <summary>Bind an event handler to the "blur" JavaScript event, or trig
ger that event on an element.</summary> |
| 984 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 985 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 986 /// <returns type="jQuery" /> |
| 987 /// </signature> |
| 988 }, |
| 989 'button': function() { |
| 990 /// <summary>Selects all button elements and elements of type button.</summa
ry> |
| 991 }, |
| 992 'change': function() { |
| 993 /// <signature> |
| 994 /// <summary>Bind an event handler to the "change" JavaScript event, or tr
igger that event on an element.</summary> |
| 995 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 996 /// <returns type="jQuery" /> |
| 997 /// </signature> |
| 998 /// <signature> |
| 999 /// <summary>Bind an event handler to the "change" JavaScript event, or tr
igger that event on an element.</summary> |
| 1000 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1001 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1002 /// <returns type="jQuery" /> |
| 1003 /// </signature> |
| 1004 }, |
| 1005 'checkbox': function() { |
| 1006 /// <summary>Selects all elements of type checkbox.</summary> |
| 1007 }, |
| 1008 'checked': function() { |
| 1009 /// <summary>Matches all elements that are checked or selected.</summary> |
| 1010 }, |
| 1011 'child': function() { |
| 1012 /// <signature> |
| 1013 /// <summary>Selects all direct child elements specified by "child" of ele
ments specified by "parent".</summary> |
| 1014 /// <param name="parent" type="String">Any valid selector.</param> |
| 1015 /// <param name="child" type="String">A selector to filter the child eleme
nts.</param> |
| 1016 /// </signature> |
| 1017 }, |
| 1018 'children': function() { |
| 1019 /// <signature> |
| 1020 /// <summary>Get the children of each element in the set of matched elemen
ts, optionally filtered by a selector.</summary> |
| 1021 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1022 /// <returns type="jQuery" /> |
| 1023 /// </signature> |
| 1024 }, |
| 1025 'class': function() { |
| 1026 /// <signature> |
| 1027 /// <summary>Selects all elements with the given class.</summary> |
| 1028 /// <param name="class" type="String">A class to search for. An element ca
n have multiple classes; only one of them must match.</param> |
| 1029 /// </signature> |
| 1030 }, |
| 1031 'clearQueue': function() { |
| 1032 /// <signature> |
| 1033 /// <summary>Remove from the queue all items that have not yet been run.</
summary> |
| 1034 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 1035 /// <returns type="jQuery" /> |
| 1036 /// </signature> |
| 1037 }, |
| 1038 'click': function() { |
| 1039 /// <signature> |
| 1040 /// <summary>Bind an event handler to the "click" JavaScript event, or tri
gger that event on an element.</summary> |
| 1041 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1042 /// <returns type="jQuery" /> |
| 1043 /// </signature> |
| 1044 /// <signature> |
| 1045 /// <summary>Bind an event handler to the "click" JavaScript event, or tri
gger that event on an element.</summary> |
| 1046 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1047 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1048 /// <returns type="jQuery" /> |
| 1049 /// </signature> |
| 1050 }, |
| 1051 'clone': function() { |
| 1052 /// <signature> |
| 1053 /// <summary>Create a deep copy of the set of matched elements.</summary> |
| 1054 /// <param name="withDataAndEvents" type="Boolean">A Boolean indicating wh
ether event handlers should be copied along with the elements. As of jQuery 1.4,
element data will be copied as well.</param> |
| 1055 /// <returns type="jQuery" /> |
| 1056 /// </signature> |
| 1057 /// <signature> |
| 1058 /// <summary>Create a deep copy of the set of matched elements.</summary> |
| 1059 /// <param name="withDataAndEvents" type="Boolean">A Boolean indicating wh
ether event handlers and data should be copied along with the elements. The defa
ult 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.</param> |
| 1060 /// <param name="deepWithDataAndEvents" type="Boolean">A Boolean indicatin
g 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 defaul
ts to false).</param> |
| 1061 /// <returns type="jQuery" /> |
| 1062 /// </signature> |
| 1063 }, |
| 1064 'closest': function() { |
| 1065 /// <signature> |
| 1066 /// <summary>For each element in the set, get the first element that match
es the selector by testing the element itself and traversing up through its ance
stors in the DOM tree.</summary> |
| 1067 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1068 /// <returns type="jQuery" /> |
| 1069 /// </signature> |
| 1070 /// <signature> |
| 1071 /// <summary>For each element in the set, get the first element that match
es the selector by testing the element itself and traversing up through its ance
stors in the DOM tree.</summary> |
| 1072 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1073 /// <param name="context" type="Element">A DOM element within which a matc
hing element may be found. If no context is passed in then the context of the jQ
uery set will be used instead.</param> |
| 1074 /// <returns type="jQuery" /> |
| 1075 /// </signature> |
| 1076 /// <signature> |
| 1077 /// <summary>For each element in the set, get the first element that match
es the selector by testing the element itself and traversing up through its ance
stors in the DOM tree.</summary> |
| 1078 /// <param name="jQuery object" type="jQuery">A jQuery object to match ele
ments against.</param> |
| 1079 /// <returns type="jQuery" /> |
| 1080 /// </signature> |
| 1081 /// <signature> |
| 1082 /// <summary>For each element in the set, get the first element that match
es the selector by testing the element itself and traversing up through its ance
stors in the DOM tree.</summary> |
| 1083 /// <param name="element" type="Element">An element to match elements agai
nst.</param> |
| 1084 /// <returns type="jQuery" /> |
| 1085 /// </signature> |
| 1086 }, |
| 1087 'contains': function() { |
| 1088 /// <signature> |
| 1089 /// <summary>Select all elements that contain the specified text.</summary
> |
| 1090 /// <param name="text" type="String">A string of text to look for. It's ca
se sensitive.</param> |
| 1091 /// </signature> |
| 1092 }, |
| 1093 'contents': function() { |
| 1094 /// <summary>Get the children of each element in the set of matched elements
, including text and comment nodes.</summary> |
| 1095 /// <returns type="jQuery" /> |
| 1096 }, |
| 1097 'context': function() { |
| 1098 /// <summary>The DOM node context originally passed to jQuery(); if none was
passed then context will likely be the document.</summary> |
| 1099 /// <returns type="Element" /> |
| 1100 }, |
| 1101 'css': function() { |
| 1102 /// <signature> |
| 1103 /// <summary>Set one or more CSS properties for the set of matched element
s.</summary> |
| 1104 /// <param name="propertyName" type="String">A CSS property name.</param> |
| 1105 /// <param name="value" type="">A value to set for the property.</param> |
| 1106 /// <returns type="jQuery" /> |
| 1107 /// </signature> |
| 1108 /// <signature> |
| 1109 /// <summary>Set one or more CSS properties for the set of matched element
s.</summary> |
| 1110 /// <param name="propertyName" type="String">A CSS property name.</param> |
| 1111 /// <param name="function(index, value)" type="Function">A function return
ing the value to set. this is the current element. Receives the index position o
f the element in the set and the old value as arguments.</param> |
| 1112 /// <returns type="jQuery" /> |
| 1113 /// </signature> |
| 1114 /// <signature> |
| 1115 /// <summary>Set one or more CSS properties for the set of matched element
s.</summary> |
| 1116 /// <param name="properties" type="PlainObject">An object of property-valu
e pairs to set.</param> |
| 1117 /// <returns type="jQuery" /> |
| 1118 /// </signature> |
| 1119 }, |
| 1120 'data': function() { |
| 1121 /// <signature> |
| 1122 /// <summary>Store arbitrary data associated with the matched elements.</s
ummary> |
| 1123 /// <param name="key" type="String">A string naming the piece of data to s
et.</param> |
| 1124 /// <param name="value" type="Object">The new data value; it can be any Ja
vascript type including Array or Object.</param> |
| 1125 /// <returns type="jQuery" /> |
| 1126 /// </signature> |
| 1127 /// <signature> |
| 1128 /// <summary>Store arbitrary data associated with the matched elements.</s
ummary> |
| 1129 /// <param name="obj" type="Object">An object of key-value pairs of data t
o update.</param> |
| 1130 /// <returns type="jQuery" /> |
| 1131 /// </signature> |
| 1132 }, |
| 1133 'dblclick': function() { |
| 1134 /// <signature> |
| 1135 /// <summary>Bind an event handler to the "dblclick" JavaScript event, or
trigger that event on an element.</summary> |
| 1136 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1137 /// <returns type="jQuery" /> |
| 1138 /// </signature> |
| 1139 /// <signature> |
| 1140 /// <summary>Bind an event handler to the "dblclick" JavaScript event, or
trigger that event on an element.</summary> |
| 1141 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1142 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1143 /// <returns type="jQuery" /> |
| 1144 /// </signature> |
| 1145 }, |
| 1146 'delay': function() { |
| 1147 /// <signature> |
| 1148 /// <summary>Set a timer to delay execution of subsequent items in the que
ue.</summary> |
| 1149 /// <param name="duration" type="Number">An integer indicating the number
of milliseconds to delay execution of the next item in the queue.</param> |
| 1150 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 1151 /// <returns type="jQuery" /> |
| 1152 /// </signature> |
| 1153 }, |
| 1154 'delegate': function() { |
| 1155 /// <signature> |
| 1156 /// <summary>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 elemen
ts.</summary> |
| 1157 /// <param name="selector" type="String">A selector to filter the elements
that trigger the event.</param> |
| 1158 /// <param name="eventType" type="String">A string containing one or more
space-separated JavaScript event types, such as "click" or "keydown," or custom
event names.</param> |
| 1159 /// <param name="handler(eventObject)" type="Function">A function to execu
te at the time the event is triggered.</param> |
| 1160 /// <returns type="jQuery" /> |
| 1161 /// </signature> |
| 1162 /// <signature> |
| 1163 /// <summary>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 elemen
ts.</summary> |
| 1164 /// <param name="selector" type="String">A selector to filter the elements
that trigger the event.</param> |
| 1165 /// <param name="eventType" type="String">A string containing one or more
space-separated JavaScript event types, such as "click" or "keydown," or custom
event names.</param> |
| 1166 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1167 /// <param name="handler(eventObject)" type="Function">A function to execu
te at the time the event is triggered.</param> |
| 1168 /// <returns type="jQuery" /> |
| 1169 /// </signature> |
| 1170 /// <signature> |
| 1171 /// <summary>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 elemen
ts.</summary> |
| 1172 /// <param name="selector" type="String">A selector to filter the elements
that trigger the event.</param> |
| 1173 /// <param name="events" type="PlainObject">A plain object of one or more
event types and functions to execute for them.</param> |
| 1174 /// <returns type="jQuery" /> |
| 1175 /// </signature> |
| 1176 }, |
| 1177 'dequeue': function() { |
| 1178 /// <signature> |
| 1179 /// <summary>Execute the next function on the queue for the matched elemen
ts.</summary> |
| 1180 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 1181 /// <returns type="jQuery" /> |
| 1182 /// </signature> |
| 1183 }, |
| 1184 'descendant': function() { |
| 1185 /// <signature> |
| 1186 /// <summary>Selects all elements that are descendants of a given ancestor
.</summary> |
| 1187 /// <param name="ancestor" type="String">Any valid selector.</param> |
| 1188 /// <param name="descendant" type="String">A selector to filter the descen
dant elements.</param> |
| 1189 /// </signature> |
| 1190 }, |
| 1191 'detach': function() { |
| 1192 /// <signature> |
| 1193 /// <summary>Remove the set of matched elements from the DOM.</summary> |
| 1194 /// <param name="selector" type="String">A selector expression that filter
s the set of matched elements to be removed.</param> |
| 1195 /// <returns type="jQuery" /> |
| 1196 /// </signature> |
| 1197 }, |
| 1198 'die': function() { |
| 1199 /// <signature> |
| 1200 /// <summary>Remove event handlers previously attached using .live() from
the elements.</summary> |
| 1201 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as click or keydown.</param> |
| 1202 /// <param name="handler" type="String">The function that is no longer to
be executed.</param> |
| 1203 /// <returns type="jQuery" /> |
| 1204 /// </signature> |
| 1205 /// <signature> |
| 1206 /// <summary>Remove event handlers previously attached using .live() from
the elements.</summary> |
| 1207 /// <param name="events" type="PlainObject">A plain object of one or more
event types, such as click or keydown and their corresponding functions that are
no longer to be executed.</param> |
| 1208 /// <returns type="jQuery" /> |
| 1209 /// </signature> |
| 1210 }, |
| 1211 'disabled': function() { |
| 1212 /// <summary>Selects all elements that are disabled.</summary> |
| 1213 }, |
| 1214 'each': function() { |
| 1215 /// <signature> |
| 1216 /// <summary>Iterate over a jQuery object, executing a function for each m
atched element.</summary> |
| 1217 /// <param name="function(index, Element)" type="Function">A function to e
xecute for each matched element.</param> |
| 1218 /// <returns type="jQuery" /> |
| 1219 /// </signature> |
| 1220 }, |
| 1221 'element': function() { |
| 1222 /// <signature> |
| 1223 /// <summary>Selects all elements with the given tag name.</summary> |
| 1224 /// <param name="element" type="String">An element to search for. Refers t
o the tagName of DOM nodes.</param> |
| 1225 /// </signature> |
| 1226 }, |
| 1227 'empty': function() { |
| 1228 /// <summary>Select all elements that have no children (including text nodes
).</summary> |
| 1229 }, |
| 1230 'enabled': function() { |
| 1231 /// <summary>Selects all elements that are enabled.</summary> |
| 1232 }, |
| 1233 'end': function() { |
| 1234 /// <summary>End the most recent filtering operation in the current chain an
d return the set of matched elements to its previous state.</summary> |
| 1235 /// <returns type="jQuery" /> |
| 1236 }, |
| 1237 'eq': function() { |
| 1238 /// <signature> |
| 1239 /// <summary>Select the element at index n within the matched set.</summar
y> |
| 1240 /// <param name="index" type="Number">Zero-based index of the element to m
atch.</param> |
| 1241 /// </signature> |
| 1242 /// <signature> |
| 1243 /// <summary>Select the element at index n within the matched set.</summar
y> |
| 1244 /// <param name="-index" type="Number">Zero-based index of the element to
match, counting backwards from the last element.</param> |
| 1245 /// </signature> |
| 1246 }, |
| 1247 'error': function() { |
| 1248 /// <signature> |
| 1249 /// <summary>Bind an event handler to the "error" JavaScript event.</summa
ry> |
| 1250 /// <param name="handler(eventObject)" type="Function">A function to execu
te when the event is triggered.</param> |
| 1251 /// <returns type="jQuery" /> |
| 1252 /// </signature> |
| 1253 /// <signature> |
| 1254 /// <summary>Bind an event handler to the "error" JavaScript event.</summa
ry> |
| 1255 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1256 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1257 /// <returns type="jQuery" /> |
| 1258 /// </signature> |
| 1259 }, |
| 1260 'even': function() { |
| 1261 /// <summary>Selects even elements, zero-indexed. See also odd.</summary> |
| 1262 }, |
| 1263 'fadeIn': function() { |
| 1264 /// <signature> |
| 1265 /// <summary>Display the matched elements by fading them to opaque.</summa
ry> |
| 1266 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1267 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1268 /// <returns type="jQuery" /> |
| 1269 /// </signature> |
| 1270 /// <signature> |
| 1271 /// <summary>Display the matched elements by fading them to opaque.</summa
ry> |
| 1272 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 1273 /// <returns type="jQuery" /> |
| 1274 /// </signature> |
| 1275 /// <signature> |
| 1276 /// <summary>Display the matched elements by fading them to opaque.</summa
ry> |
| 1277 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1278 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 1279 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1280 /// <returns type="jQuery" /> |
| 1281 /// </signature> |
| 1282 }, |
| 1283 'fadeOut': function() { |
| 1284 /// <signature> |
| 1285 /// <summary>Hide the matched elements by fading them to transparent.</sum
mary> |
| 1286 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1287 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1288 /// <returns type="jQuery" /> |
| 1289 /// </signature> |
| 1290 /// <signature> |
| 1291 /// <summary>Hide the matched elements by fading them to transparent.</sum
mary> |
| 1292 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 1293 /// <returns type="jQuery" /> |
| 1294 /// </signature> |
| 1295 /// <signature> |
| 1296 /// <summary>Hide the matched elements by fading them to transparent.</sum
mary> |
| 1297 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1298 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 1299 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1300 /// <returns type="jQuery" /> |
| 1301 /// </signature> |
| 1302 }, |
| 1303 'fadeTo': function() { |
| 1304 /// <signature> |
| 1305 /// <summary>Adjust the opacity of the matched elements.</summary> |
| 1306 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1307 /// <param name="opacity" type="Number">A number between 0 and 1 denoting
the target opacity.</param> |
| 1308 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1309 /// <returns type="jQuery" /> |
| 1310 /// </signature> |
| 1311 /// <signature> |
| 1312 /// <summary>Adjust the opacity of the matched elements.</summary> |
| 1313 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1314 /// <param name="opacity" type="Number">A number between 0 and 1 denoting
the target opacity.</param> |
| 1315 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 1316 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1317 /// <returns type="jQuery" /> |
| 1318 /// </signature> |
| 1319 }, |
| 1320 'fadeToggle': function() { |
| 1321 /// <signature> |
| 1322 /// <summary>Display or hide the matched elements by animating their opaci
ty.</summary> |
| 1323 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1324 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 1325 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1326 /// <returns type="jQuery" /> |
| 1327 /// </signature> |
| 1328 /// <signature> |
| 1329 /// <summary>Display or hide the matched elements by animating their opaci
ty.</summary> |
| 1330 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 1331 /// <returns type="jQuery" /> |
| 1332 /// </signature> |
| 1333 }, |
| 1334 'file': function() { |
| 1335 /// <summary>Selects all elements of type file.</summary> |
| 1336 }, |
| 1337 'filter': function() { |
| 1338 /// <signature> |
| 1339 /// <summary>Reduce the set of matched elements to those that match the se
lector or pass the function's test.</summary> |
| 1340 /// <param name="selector" type="String">A string containing a selector ex
pression to match the current set of elements against.</param> |
| 1341 /// <returns type="jQuery" /> |
| 1342 /// </signature> |
| 1343 /// <signature> |
| 1344 /// <summary>Reduce the set of matched elements to those that match the se
lector or pass the function's test.</summary> |
| 1345 /// <param name="function(index)" type="Function">A function used as a tes
t for each element in the set. this is the current DOM element.</param> |
| 1346 /// <returns type="jQuery" /> |
| 1347 /// </signature> |
| 1348 /// <signature> |
| 1349 /// <summary>Reduce the set of matched elements to those that match the se
lector or pass the function's test.</summary> |
| 1350 /// <param name="element" type="Element">An element to match the current s
et of elements against.</param> |
| 1351 /// <returns type="jQuery" /> |
| 1352 /// </signature> |
| 1353 /// <signature> |
| 1354 /// <summary>Reduce the set of matched elements to those that match the se
lector or pass the function's test.</summary> |
| 1355 /// <param name="jQuery object" type="Object">An existing jQuery object to
match the current set of elements against.</param> |
| 1356 /// <returns type="jQuery" /> |
| 1357 /// </signature> |
| 1358 }, |
| 1359 'find': function() { |
| 1360 /// <signature> |
| 1361 /// <summary>Get the descendants of each element in the current set of mat
ched elements, filtered by a selector, jQuery object, or element.</summary> |
| 1362 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1363 /// <returns type="jQuery" /> |
| 1364 /// </signature> |
| 1365 /// <signature> |
| 1366 /// <summary>Get the descendants of each element in the current set of mat
ched elements, filtered by a selector, jQuery object, or element.</summary> |
| 1367 /// <param name="jQuery object" type="Object">A jQuery object to match ele
ments against.</param> |
| 1368 /// <returns type="jQuery" /> |
| 1369 /// </signature> |
| 1370 /// <signature> |
| 1371 /// <summary>Get the descendants of each element in the current set of mat
ched elements, filtered by a selector, jQuery object, or element.</summary> |
| 1372 /// <param name="element" type="Element">An element to match elements agai
nst.</param> |
| 1373 /// <returns type="jQuery" /> |
| 1374 /// </signature> |
| 1375 }, |
| 1376 'finish': function() { |
| 1377 /// <signature> |
| 1378 /// <summary>Stop the currently-running animation, remove all queued anima
tions, and complete all animations for the matched elements.</summary> |
| 1379 /// <param name="queue" type="String">The name of the queue in which to st
op animations.</param> |
| 1380 /// <returns type="jQuery" /> |
| 1381 /// </signature> |
| 1382 }, |
| 1383 'first': function() { |
| 1384 /// <summary>Selects the first matched element.</summary> |
| 1385 }, |
| 1386 'first-child': function() { |
| 1387 /// <summary>Selects all elements that are the first child of their parent.<
/summary> |
| 1388 }, |
| 1389 'first-of-type': function() { |
| 1390 /// <summary>Selects all elements that are the first among siblings of the s
ame element name.</summary> |
| 1391 }, |
| 1392 'focus': function() { |
| 1393 /// <signature> |
| 1394 /// <summary>Bind an event handler to the "focus" JavaScript event, or tri
gger that event on an element.</summary> |
| 1395 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1396 /// <returns type="jQuery" /> |
| 1397 /// </signature> |
| 1398 /// <signature> |
| 1399 /// <summary>Bind an event handler to the "focus" JavaScript event, or tri
gger that event on an element.</summary> |
| 1400 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1401 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1402 /// <returns type="jQuery" /> |
| 1403 /// </signature> |
| 1404 }, |
| 1405 'focusin': function() { |
| 1406 /// <signature> |
| 1407 /// <summary>Bind an event handler to the "focusin" event.</summary> |
| 1408 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1409 /// <returns type="jQuery" /> |
| 1410 /// </signature> |
| 1411 /// <signature> |
| 1412 /// <summary>Bind an event handler to the "focusin" event.</summary> |
| 1413 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1414 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1415 /// <returns type="jQuery" /> |
| 1416 /// </signature> |
| 1417 }, |
| 1418 'focusout': function() { |
| 1419 /// <signature> |
| 1420 /// <summary>Bind an event handler to the "focusout" JavaScript event.</su
mmary> |
| 1421 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1422 /// <returns type="jQuery" /> |
| 1423 /// </signature> |
| 1424 /// <signature> |
| 1425 /// <summary>Bind an event handler to the "focusout" JavaScript event.</su
mmary> |
| 1426 /// <param name="eventData" type="Object">An object containing data that w
ill be passed to the event handler.</param> |
| 1427 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1428 /// <returns type="jQuery" /> |
| 1429 /// </signature> |
| 1430 }, |
| 1431 'get': function() { |
| 1432 /// <signature> |
| 1433 /// <summary>Retrieve one of the DOM elements matched by the jQuery object
.</summary> |
| 1434 /// <param name="index" type="Number">A zero-based integer indicating whic
h element to retrieve.</param> |
| 1435 /// <returns type="Element" /> |
| 1436 /// </signature> |
| 1437 }, |
| 1438 'gt': function() { |
| 1439 /// <signature> |
| 1440 /// <summary>Select all elements at an index greater than index within the
matched set.</summary> |
| 1441 /// <param name="index" type="Number">Zero-based index.</param> |
| 1442 /// </signature> |
| 1443 /// <signature> |
| 1444 /// <summary>Select all elements at an index greater than index within the
matched set.</summary> |
| 1445 /// <param name="-index" type="Number">Zero-based index, counting backward
s from the last element.</param> |
| 1446 /// </signature> |
| 1447 }, |
| 1448 'has': function() { |
| 1449 /// <signature> |
| 1450 /// <summary>Reduce the set of matched elements to those that have a desce
ndant that matches the selector or DOM element.</summary> |
| 1451 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1452 /// <returns type="jQuery" /> |
| 1453 /// </signature> |
| 1454 /// <signature> |
| 1455 /// <summary>Reduce the set of matched elements to those that have a desce
ndant that matches the selector or DOM element.</summary> |
| 1456 /// <param name="contained" type="Element">A DOM element to match elements
against.</param> |
| 1457 /// <returns type="jQuery" /> |
| 1458 /// </signature> |
| 1459 }, |
| 1460 'hasClass': function() { |
| 1461 /// <signature> |
| 1462 /// <summary>Determine whether any of the matched elements are assigned th
e given class.</summary> |
| 1463 /// <param name="className" type="String">The class name to search for.</p
aram> |
| 1464 /// <returns type="Boolean" /> |
| 1465 /// </signature> |
| 1466 }, |
| 1467 'header': function() { |
| 1468 /// <summary>Selects all elements that are headers, like h1, h2, h3 and so o
n.</summary> |
| 1469 }, |
| 1470 'height': function() { |
| 1471 /// <signature> |
| 1472 /// <summary>Set the CSS height of every matched element.</summary> |
| 1473 /// <param name="value" type="">An integer representing the number of pixe
ls, or an integer with an optional unit of measure appended (as a string).</para
m> |
| 1474 /// <returns type="jQuery" /> |
| 1475 /// </signature> |
| 1476 /// <signature> |
| 1477 /// <summary>Set the CSS height of every matched element.</summary> |
| 1478 /// <param name="function(index, height)" type="Function">A function retur
ning the height to set. Receives the index position of the element in the set an
d the old height as arguments. Within the function, this refers to the current e
lement in the set.</param> |
| 1479 /// <returns type="jQuery" /> |
| 1480 /// </signature> |
| 1481 }, |
| 1482 'hidden': function() { |
| 1483 /// <summary>Selects all elements that are hidden.</summary> |
| 1484 }, |
| 1485 'hide': function() { |
| 1486 /// <signature> |
| 1487 /// <summary>Hide the matched elements.</summary> |
| 1488 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1489 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1490 /// <returns type="jQuery" /> |
| 1491 /// </signature> |
| 1492 /// <signature> |
| 1493 /// <summary>Hide the matched elements.</summary> |
| 1494 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 1495 /// <returns type="jQuery" /> |
| 1496 /// </signature> |
| 1497 /// <signature> |
| 1498 /// <summary>Hide the matched elements.</summary> |
| 1499 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 1500 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 1501 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 1502 /// <returns type="jQuery" /> |
| 1503 /// </signature> |
| 1504 }, |
| 1505 'hover': function() { |
| 1506 /// <signature> |
| 1507 /// <summary>Bind two handlers to the matched elements, to be executed whe
n the mouse pointer enters and leaves the elements.</summary> |
| 1508 /// <param name="handlerIn(eventObject)" type="Function">A function to exe
cute when the mouse pointer enters the element.</param> |
| 1509 /// <param name="handlerOut(eventObject)" type="Function">A function to ex
ecute when the mouse pointer leaves the element.</param> |
| 1510 /// <returns type="jQuery" /> |
| 1511 /// </signature> |
| 1512 }, |
| 1513 'html': function() { |
| 1514 /// <signature> |
| 1515 /// <summary>Set the HTML contents of each element in the set of matched e
lements.</summary> |
| 1516 /// <param name="htmlString" type="htmlString">A string of HTML to set as
the content of each matched element.</param> |
| 1517 /// <returns type="jQuery" /> |
| 1518 /// </signature> |
| 1519 /// <signature> |
| 1520 /// <summary>Set the HTML contents of each element in the set of matched e
lements.</summary> |
| 1521 /// <param name="function(index, oldhtml)" type="Function">A function retu
rning the HTML content to set. Receives the index position of the elem
ent in the set and the old HTML value as arguments. jQuery empties the
element before calling the function; use the oldhtml argument to refe
rence the previous content. Within the function, this refers to the cu
rrent element in the set.</param> |
| 1522 /// <returns type="jQuery" /> |
| 1523 /// </signature> |
| 1524 }, |
| 1525 'id': function() { |
| 1526 /// <signature> |
| 1527 /// <summary>Selects a single element with the given id attribute.</summar
y> |
| 1528 /// <param name="id" type="String">An ID to search for, specified via the
id attribute of an element.</param> |
| 1529 /// </signature> |
| 1530 }, |
| 1531 'image': function() { |
| 1532 /// <summary>Selects all elements of type image.</summary> |
| 1533 }, |
| 1534 'index': function() { |
| 1535 /// <signature> |
| 1536 /// <summary>Search for a given element from among the matched elements.</
summary> |
| 1537 /// <param name="selector" type="String">A selector representing a jQuery
collection in which to look for an element.</param> |
| 1538 /// <returns type="Number" /> |
| 1539 /// </signature> |
| 1540 /// <signature> |
| 1541 /// <summary>Search for a given element from among the matched elements.</
summary> |
| 1542 /// <param name="element" type="">The DOM element or first element within
the jQuery object to look for.</param> |
| 1543 /// <returns type="Number" /> |
| 1544 /// </signature> |
| 1545 }, |
| 1546 'init': function() { |
| 1547 /// <signature> |
| 1548 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 1549 /// <param name="selector" type="String">A string containing a selector ex
pression</param> |
| 1550 /// <param name="context" type="">A DOM Element, Document, or jQuery to us
e as context</param> |
| 1551 /// <returns type="jQuery" /> |
| 1552 /// </signature> |
| 1553 /// <signature> |
| 1554 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 1555 /// <param name="element" type="Element">A DOM element to wrap in a jQuery
object.</param> |
| 1556 /// <returns type="jQuery" /> |
| 1557 /// </signature> |
| 1558 /// <signature> |
| 1559 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 1560 /// <param name="elementArray" type="Array">An array containing a set of D
OM elements to wrap in a jQuery object.</param> |
| 1561 /// <returns type="jQuery" /> |
| 1562 /// </signature> |
| 1563 /// <signature> |
| 1564 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 1565 /// <param name="object" type="PlainObject">A plain object to wrap in a jQ
uery object.</param> |
| 1566 /// <returns type="jQuery" /> |
| 1567 /// </signature> |
| 1568 /// <signature> |
| 1569 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 1570 /// <param name="jQuery object" type="PlainObject">An existing jQuery obje
ct to clone.</param> |
| 1571 /// <returns type="jQuery" /> |
| 1572 /// </signature> |
| 1573 }, |
| 1574 'innerHeight': function() { |
| 1575 /// <summary>Get the current computed height for the first element in the se
t of matched elements, including padding but not border.</summary> |
| 1576 /// <returns type="Number" /> |
| 1577 }, |
| 1578 'innerWidth': function() { |
| 1579 /// <summary>Get the current computed width for the first element in the set
of matched elements, including padding but not border.</summary> |
| 1580 /// <returns type="Number" /> |
| 1581 }, |
| 1582 'input': function() { |
| 1583 /// <summary>Selects all input, textarea, select and button elements.</summa
ry> |
| 1584 }, |
| 1585 'insertAfter': function() { |
| 1586 /// <signature> |
| 1587 /// <summary>Insert every element in the set of matched elements after the
target.</summary> |
| 1588 /// <param name="target" type="">A selector, element, HTML string, or jQue
ry object; the matched set of elements will be inserted after the element(s) spe
cified by this parameter.</param> |
| 1589 /// <returns type="jQuery" /> |
| 1590 /// </signature> |
| 1591 }, |
| 1592 'insertBefore': function() { |
| 1593 /// <signature> |
| 1594 /// <summary>Insert every element in the set of matched elements before th
e target.</summary> |
| 1595 /// <param name="target" type="">A selector, element, HTML string, or jQue
ry object; the matched set of elements will be inserted before the element(s) sp
ecified by this parameter.</param> |
| 1596 /// <returns type="jQuery" /> |
| 1597 /// </signature> |
| 1598 }, |
| 1599 'is': function() { |
| 1600 /// <signature> |
| 1601 /// <summary>Check the current matched set of elements against a selector,
element, or jQuery object and return true if at least one of these elements mat
ches the given arguments.</summary> |
| 1602 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1603 /// <returns type="Boolean" /> |
| 1604 /// </signature> |
| 1605 /// <signature> |
| 1606 /// <summary>Check the current matched set of elements against a selector,
element, or jQuery object and return true if at least one of these elements mat
ches the given arguments.</summary> |
| 1607 /// <param name="function(index)" type="Function">A function used as a tes
t 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.</param> |
| 1608 /// <returns type="Boolean" /> |
| 1609 /// </signature> |
| 1610 /// <signature> |
| 1611 /// <summary>Check the current matched set of elements against a selector,
element, or jQuery object and return true if at least one of these elements mat
ches the given arguments.</summary> |
| 1612 /// <param name="jQuery object" type="Object">An existing jQuery object to
match the current set of elements against.</param> |
| 1613 /// <returns type="Boolean" /> |
| 1614 /// </signature> |
| 1615 /// <signature> |
| 1616 /// <summary>Check the current matched set of elements against a selector,
element, or jQuery object and return true if at least one of these elements mat
ches the given arguments.</summary> |
| 1617 /// <param name="element" type="Element">An element to match the current s
et of elements against.</param> |
| 1618 /// <returns type="Boolean" /> |
| 1619 /// </signature> |
| 1620 }, |
| 1621 'jquery': function() { |
| 1622 /// <summary>A string containing the jQuery version number.</summary> |
| 1623 /// <returns type="String" /> |
| 1624 }, |
| 1625 'keydown': function() { |
| 1626 /// <signature> |
| 1627 /// <summary>Bind an event handler to the "keydown" JavaScript event, or t
rigger that event on an element.</summary> |
| 1628 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1629 /// <returns type="jQuery" /> |
| 1630 /// </signature> |
| 1631 /// <signature> |
| 1632 /// <summary>Bind an event handler to the "keydown" JavaScript event, or t
rigger that event on an element.</summary> |
| 1633 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1634 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1635 /// <returns type="jQuery" /> |
| 1636 /// </signature> |
| 1637 }, |
| 1638 'keypress': function() { |
| 1639 /// <signature> |
| 1640 /// <summary>Bind an event handler to the "keypress" JavaScript event, or
trigger that event on an element.</summary> |
| 1641 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1642 /// <returns type="jQuery" /> |
| 1643 /// </signature> |
| 1644 /// <signature> |
| 1645 /// <summary>Bind an event handler to the "keypress" JavaScript event, or
trigger that event on an element.</summary> |
| 1646 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1647 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1648 /// <returns type="jQuery" /> |
| 1649 /// </signature> |
| 1650 }, |
| 1651 'keyup': function() { |
| 1652 /// <signature> |
| 1653 /// <summary>Bind an event handler to the "keyup" JavaScript event, or tri
gger that event on an element.</summary> |
| 1654 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1655 /// <returns type="jQuery" /> |
| 1656 /// </signature> |
| 1657 /// <signature> |
| 1658 /// <summary>Bind an event handler to the "keyup" JavaScript event, or tri
gger that event on an element.</summary> |
| 1659 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1660 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1661 /// <returns type="jQuery" /> |
| 1662 /// </signature> |
| 1663 }, |
| 1664 'lang': function() { |
| 1665 /// <signature> |
| 1666 /// <summary>Selects all elements of the specified language.</summary> |
| 1667 /// <param name="language" type="String">A language code.</param> |
| 1668 /// </signature> |
| 1669 }, |
| 1670 'last': function() { |
| 1671 /// <summary>Selects the last matched element.</summary> |
| 1672 }, |
| 1673 'last-child': function() { |
| 1674 /// <summary>Selects all elements that are the last child of their parent.</
summary> |
| 1675 }, |
| 1676 'last-of-type': function() { |
| 1677 /// <summary>Selects all elements that are the last among siblings of the sa
me element name.</summary> |
| 1678 }, |
| 1679 'length': function() { |
| 1680 /// <summary>The number of elements in the jQuery object.</summary> |
| 1681 /// <returns type="Number" /> |
| 1682 }, |
| 1683 'live': function() { |
| 1684 /// <signature> |
| 1685 /// <summary>Attach an event handler for all elements which match the curr
ent selector, now and in the future.</summary> |
| 1686 /// <param name="events" type="String">A string containing a JavaScript ev
ent type, such as "click" or "keydown." As of jQuery 1.4 the string can contain
multiple, space-separated event types or custom event names.</param> |
| 1687 /// <param name="handler(eventObject)" type="Function">A function to execu
te at the time the event is triggered.</param> |
| 1688 /// <returns type="jQuery" /> |
| 1689 /// </signature> |
| 1690 /// <signature> |
| 1691 /// <summary>Attach an event handler for all elements which match the curr
ent selector, now and in the future.</summary> |
| 1692 /// <param name="events" type="String">A string containing a JavaScript ev
ent type, such as "click" or "keydown." As of jQuery 1.4 the string can contain
multiple, space-separated event types or custom event names.</param> |
| 1693 /// <param name="data" type="PlainObject">An object containing data that w
ill be passed to the event handler.</param> |
| 1694 /// <param name="handler(eventObject)" type="Function">A function to execu
te at the time the event is triggered.</param> |
| 1695 /// <returns type="jQuery" /> |
| 1696 /// </signature> |
| 1697 /// <signature> |
| 1698 /// <summary>Attach an event handler for all elements which match the curr
ent selector, now and in the future.</summary> |
| 1699 /// <param name="events" type="PlainObject">A plain object of one or more
JavaScript event types and functions to execute for them.</param> |
| 1700 /// <returns type="jQuery" /> |
| 1701 /// </signature> |
| 1702 }, |
| 1703 'load': function() { |
| 1704 /// <signature> |
| 1705 /// <summary>Bind an event handler to the "load" JavaScript event.</summar
y> |
| 1706 /// <param name="handler(eventObject)" type="Function">A function to execu
te when the event is triggered.</param> |
| 1707 /// <returns type="jQuery" /> |
| 1708 /// </signature> |
| 1709 /// <signature> |
| 1710 /// <summary>Bind an event handler to the "load" JavaScript event.</summar
y> |
| 1711 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1712 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1713 /// <returns type="jQuery" /> |
| 1714 /// </signature> |
| 1715 }, |
| 1716 'lt': function() { |
| 1717 /// <signature> |
| 1718 /// <summary>Select all elements at an index less than index within the ma
tched set.</summary> |
| 1719 /// <param name="index" type="Number">Zero-based index.</param> |
| 1720 /// </signature> |
| 1721 /// <signature> |
| 1722 /// <summary>Select all elements at an index less than index within the ma
tched set.</summary> |
| 1723 /// <param name="-index" type="Number">Zero-based index, counting backward
s from the last element.</param> |
| 1724 /// </signature> |
| 1725 }, |
| 1726 'map': function() { |
| 1727 /// <signature> |
| 1728 /// <summary>Pass each element in the current matched set through a functi
on, producing a new jQuery object containing the return values.</summary> |
| 1729 /// <param name="callback(index, domElement)" type="Function">A function o
bject that will be invoked for each element in the current set.</param> |
| 1730 /// <returns type="jQuery" /> |
| 1731 /// </signature> |
| 1732 }, |
| 1733 'mousedown': function() { |
| 1734 /// <signature> |
| 1735 /// <summary>Bind an event handler to the "mousedown" JavaScript event, or
trigger that event on an element.</summary> |
| 1736 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1737 /// <returns type="jQuery" /> |
| 1738 /// </signature> |
| 1739 /// <signature> |
| 1740 /// <summary>Bind an event handler to the "mousedown" JavaScript event, or
trigger that event on an element.</summary> |
| 1741 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1742 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1743 /// <returns type="jQuery" /> |
| 1744 /// </signature> |
| 1745 }, |
| 1746 'mouseenter': function() { |
| 1747 /// <signature> |
| 1748 /// <summary>Bind an event handler to be fired when the mouse enters an el
ement, or trigger that handler on an element.</summary> |
| 1749 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1750 /// <returns type="jQuery" /> |
| 1751 /// </signature> |
| 1752 /// <signature> |
| 1753 /// <summary>Bind an event handler to be fired when the mouse enters an el
ement, or trigger that handler on an element.</summary> |
| 1754 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1755 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1756 /// <returns type="jQuery" /> |
| 1757 /// </signature> |
| 1758 }, |
| 1759 'mouseleave': function() { |
| 1760 /// <signature> |
| 1761 /// <summary>Bind an event handler to be fired when the mouse leaves an el
ement, or trigger that handler on an element.</summary> |
| 1762 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1763 /// <returns type="jQuery" /> |
| 1764 /// </signature> |
| 1765 /// <signature> |
| 1766 /// <summary>Bind an event handler to be fired when the mouse leaves an el
ement, or trigger that handler on an element.</summary> |
| 1767 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1768 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1769 /// <returns type="jQuery" /> |
| 1770 /// </signature> |
| 1771 }, |
| 1772 'mousemove': function() { |
| 1773 /// <signature> |
| 1774 /// <summary>Bind an event handler to the "mousemove" JavaScript event, or
trigger that event on an element.</summary> |
| 1775 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1776 /// <returns type="jQuery" /> |
| 1777 /// </signature> |
| 1778 /// <signature> |
| 1779 /// <summary>Bind an event handler to the "mousemove" JavaScript event, or
trigger that event on an element.</summary> |
| 1780 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1781 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1782 /// <returns type="jQuery" /> |
| 1783 /// </signature> |
| 1784 }, |
| 1785 'mouseout': function() { |
| 1786 /// <signature> |
| 1787 /// <summary>Bind an event handler to the "mouseout" JavaScript event, or
trigger that event on an element.</summary> |
| 1788 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1789 /// <returns type="jQuery" /> |
| 1790 /// </signature> |
| 1791 /// <signature> |
| 1792 /// <summary>Bind an event handler to the "mouseout" JavaScript event, or
trigger that event on an element.</summary> |
| 1793 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1794 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1795 /// <returns type="jQuery" /> |
| 1796 /// </signature> |
| 1797 }, |
| 1798 'mouseover': function() { |
| 1799 /// <signature> |
| 1800 /// <summary>Bind an event handler to the "mouseover" JavaScript event, or
trigger that event on an element.</summary> |
| 1801 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1802 /// <returns type="jQuery" /> |
| 1803 /// </signature> |
| 1804 /// <signature> |
| 1805 /// <summary>Bind an event handler to the "mouseover" JavaScript event, or
trigger that event on an element.</summary> |
| 1806 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1807 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1808 /// <returns type="jQuery" /> |
| 1809 /// </signature> |
| 1810 }, |
| 1811 'mouseup': function() { |
| 1812 /// <signature> |
| 1813 /// <summary>Bind an event handler to the "mouseup" JavaScript event, or t
rigger that event on an element.</summary> |
| 1814 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1815 /// <returns type="jQuery" /> |
| 1816 /// </signature> |
| 1817 /// <signature> |
| 1818 /// <summary>Bind an event handler to the "mouseup" JavaScript event, or t
rigger that event on an element.</summary> |
| 1819 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 1820 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 1821 /// <returns type="jQuery" /> |
| 1822 /// </signature> |
| 1823 }, |
| 1824 'multiple': function() { |
| 1825 /// <signature> |
| 1826 /// <summary>Selects the combined results of all the specified selectors.<
/summary> |
| 1827 /// <param name="selector1" type="String">Any valid selector.</param> |
| 1828 /// <param name="selector2" type="String">Another valid selector.</param> |
| 1829 /// <param name="selectorN" type="String">As many more valid selectors as
you like.</param> |
| 1830 /// </signature> |
| 1831 }, |
| 1832 'next': function() { |
| 1833 /// <signature> |
| 1834 /// <summary>Get the immediately following sibling of each element in the
set of matched elements. If a selector is provided, it retrieves the next siblin
g only if it matches that selector.</summary> |
| 1835 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1836 /// <returns type="jQuery" /> |
| 1837 /// </signature> |
| 1838 }, |
| 1839 'next adjacent': function() { |
| 1840 /// <signature> |
| 1841 /// <summary>Selects all next elements matching "next" that are immediatel
y preceded by a sibling "prev".</summary> |
| 1842 /// <param name="prev" type="String">Any valid selector.</param> |
| 1843 /// <param name="next" type="String">A selector to match the element that
is next to the first selector.</param> |
| 1844 /// </signature> |
| 1845 }, |
| 1846 'next siblings': function() { |
| 1847 /// <signature> |
| 1848 /// <summary>Selects all sibling elements that follow after the "prev" ele
ment, have the same parent, and match the filtering "siblings" selector.</summar
y> |
| 1849 /// <param name="prev" type="String">Any valid selector.</param> |
| 1850 /// <param name="siblings" type="String">A selector to filter elements tha
t are the following siblings of the first selector.</param> |
| 1851 /// </signature> |
| 1852 }, |
| 1853 'nextAll': function() { |
| 1854 /// <signature> |
| 1855 /// <summary>Get all following siblings of each element in the set of matc
hed elements, optionally filtered by a selector.</summary> |
| 1856 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1857 /// <returns type="jQuery" /> |
| 1858 /// </signature> |
| 1859 }, |
| 1860 'nextUntil': function() { |
| 1861 /// <signature> |
| 1862 /// <summary>Get all following siblings of each element up to but not incl
uding the element matched by the selector, DOM node, or jQuery object passed.</s
ummary> |
| 1863 /// <param name="selector" type="String">A string containing a selector ex
pression to indicate where to stop matching following sibling elements.</param> |
| 1864 /// <param name="filter" type="String">A string containing a selector expr
ession to match elements against.</param> |
| 1865 /// <returns type="jQuery" /> |
| 1866 /// </signature> |
| 1867 /// <signature> |
| 1868 /// <summary>Get all following siblings of each element up to but not incl
uding the element matched by the selector, DOM node, or jQuery object passed.</s
ummary> |
| 1869 /// <param name="element" type="Element">A DOM node or jQuery object indic
ating where to stop matching following sibling elements.</param> |
| 1870 /// <param name="filter" type="String">A string containing a selector expr
ession to match elements against.</param> |
| 1871 /// <returns type="jQuery" /> |
| 1872 /// </signature> |
| 1873 }, |
| 1874 'not': function() { |
| 1875 /// <signature> |
| 1876 /// <summary>Remove elements from the set of matched elements.</summary> |
| 1877 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 1878 /// <returns type="jQuery" /> |
| 1879 /// </signature> |
| 1880 /// <signature> |
| 1881 /// <summary>Remove elements from the set of matched elements.</summary> |
| 1882 /// <param name="elements" type="Array">One or more DOM elements to remove
from the matched set.</param> |
| 1883 /// <returns type="jQuery" /> |
| 1884 /// </signature> |
| 1885 /// <signature> |
| 1886 /// <summary>Remove elements from the set of matched elements.</summary> |
| 1887 /// <param name="function(index)" type="Function">A function used as a tes
t for each element in the set. this is the current DOM element.</param> |
| 1888 /// <returns type="jQuery" /> |
| 1889 /// </signature> |
| 1890 /// <signature> |
| 1891 /// <summary>Remove elements from the set of matched elements.</summary> |
| 1892 /// <param name="jQuery object" type="PlainObject">An existing jQuery obje
ct to match the current set of elements against.</param> |
| 1893 /// <returns type="jQuery" /> |
| 1894 /// </signature> |
| 1895 }, |
| 1896 'nth-child': function() { |
| 1897 /// <signature> |
| 1898 /// <summary>Selects all elements that are the nth-child of their parent.<
/summary> |
| 1899 /// <param name="index" type="String">The index of each child to match, st
arting with 1, the string even or odd, or an equation ( eg. :nth-child(even), :n
th-child(4n) )</param> |
| 1900 /// </signature> |
| 1901 }, |
| 1902 'nth-last-child': function() { |
| 1903 /// <signature> |
| 1904 /// <summary>Selects all elements that are the nth-child of their parent,
counting from the last element to the first.</summary> |
| 1905 /// <param name="index" type="String">The index of each child to match, st
arting with the last one (1), the string even or odd, or an equation ( eg. :nth-
last-child(even), :nth-last-child(4n) )</param> |
| 1906 /// </signature> |
| 1907 }, |
| 1908 'nth-last-of-type': function() { |
| 1909 /// <signature> |
| 1910 /// <summary>Selects all elements that are the nth-child of their parent,
counting from the last element to the first.</summary> |
| 1911 /// <param name="index" type="String">The index of each child to match, st
arting with the last one (1), the string even or odd, or an equation ( eg. :nth-
last-of-type(even), :nth-last-of-type(4n) )</param> |
| 1912 /// </signature> |
| 1913 }, |
| 1914 'nth-of-type': function() { |
| 1915 /// <signature> |
| 1916 /// <summary>Selects all elements that are the nth child of their parent i
n relation to siblings with the same element name.</summary> |
| 1917 /// <param name="index" type="String">The index of each child to match, st
arting with 1, the string even or odd, or an equation ( eg. :nth-of-type(even),
:nth-of-type(4n) )</param> |
| 1918 /// </signature> |
| 1919 }, |
| 1920 'odd': function() { |
| 1921 /// <summary>Selects odd elements, zero-indexed. See also even.</summary> |
| 1922 }, |
| 1923 'off': function() { |
| 1924 /// <signature> |
| 1925 /// <summary>Remove an event handler.</summary> |
| 1926 /// <param name="events" type="String">One or more space-separated event t
ypes and optional namespaces, or just namespaces, such as "click", "keydown.myPl
ugin", or ".myPlugin".</param> |
| 1927 /// <param name="selector" type="String">A selector which should match the
one originally passed to .on() when attaching event handlers.</param> |
| 1928 /// <param name="handler(eventObject)" type="Function">A handler function
previously attached for the event(s), or the special value false.</param> |
| 1929 /// <returns type="jQuery" /> |
| 1930 /// </signature> |
| 1931 /// <signature> |
| 1932 /// <summary>Remove an event handler.</summary> |
| 1933 /// <param name="events" type="PlainObject">An object where the string key
s represent one or more space-separated event types and optional namespaces, and
the values represent handler functions previously attached for the event(s).</p
aram> |
| 1934 /// <param name="selector" type="String">A selector which should match the
one originally passed to .on() when attaching event handlers.</param> |
| 1935 /// <returns type="jQuery" /> |
| 1936 /// </signature> |
| 1937 }, |
| 1938 'offset': function() { |
| 1939 /// <signature> |
| 1940 /// <summary>Set the current coordinates of every element in the set of ma
tched elements, relative to the document.</summary> |
| 1941 /// <param name="coordinates" type="PlainObject">An object containing the
properties top and left, which are integers indicating the new top and left coor
dinates for the elements.</param> |
| 1942 /// <returns type="jQuery" /> |
| 1943 /// </signature> |
| 1944 /// <signature> |
| 1945 /// <summary>Set the current coordinates of every element in the set of ma
tched elements, relative to the document.</summary> |
| 1946 /// <param name="function(index, coords)" type="Function">A function to re
turn 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 f
unction should return an object with the new top and left properties.</param> |
| 1947 /// <returns type="jQuery" /> |
| 1948 /// </signature> |
| 1949 }, |
| 1950 'offsetParent': function() { |
| 1951 /// <summary>Get the closest ancestor element that is positioned.</summary> |
| 1952 /// <returns type="jQuery" /> |
| 1953 }, |
| 1954 'on': function() { |
| 1955 /// <signature> |
| 1956 /// <summary>Attach an event handler function for one or more events to th
e selected elements.</summary> |
| 1957 /// <param name="events" type="String">One or more space-separated event t
ypes and optional namespaces, such as "click" or "keydown.myPlugin".</param> |
| 1958 /// <param name="selector" type="String">A selector string to filter the d
escendants of the selected elements that trigger the event. If the selector is n
ull or omitted, the event is always triggered when it reaches the selected eleme
nt.</param> |
| 1959 /// <param name="data" type="Anything">Data to be passed to the handler in
event.data when an event is triggered.</param> |
| 1960 /// <param name="handler(eventObject)" type="Function">A function to execu
te when the event is triggered. The value false is also allowed as a shorthand f
or a function that simply does return false.</param> |
| 1961 /// <returns type="jQuery" /> |
| 1962 /// </signature> |
| 1963 /// <signature> |
| 1964 /// <summary>Attach an event handler function for one or more events to th
e selected elements.</summary> |
| 1965 /// <param name="events" type="PlainObject">An object in which the string
keys represent one or more space-separated event types and optional namespaces,
and the values represent a handler function to be called for the event(s).</para
m> |
| 1966 /// <param name="selector" type="String">A selector string to filter the d
escendants 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 el
ement.</param> |
| 1967 /// <param name="data" type="Anything">Data to be passed to the handler in
event.data when an event occurs.</param> |
| 1968 /// <returns type="jQuery" /> |
| 1969 /// </signature> |
| 1970 }, |
| 1971 'one': function() { |
| 1972 /// <signature> |
| 1973 /// <summary>Attach a handler to an event for the elements. The handler is
executed at most once per element.</summary> |
| 1974 /// <param name="events" type="String">A string containing one or more Jav
aScript event types, such as "click" or "submit," or custom event names.</param> |
| 1975 /// <param name="data" type="PlainObject">An object containing data that w
ill be passed to the event handler.</param> |
| 1976 /// <param name="handler(eventObject)" type="Function">A function to execu
te at the time the event is triggered.</param> |
| 1977 /// <returns type="jQuery" /> |
| 1978 /// </signature> |
| 1979 /// <signature> |
| 1980 /// <summary>Attach a handler to an event for the elements. The handler is
executed at most once per element.</summary> |
| 1981 /// <param name="events" type="String">One or more space-separated event t
ypes and optional namespaces, such as "click" or "keydown.myPlugin".</param> |
| 1982 /// <param name="selector" type="String">A selector string to filter the d
escendants of the selected elements that trigger the event. If the selector is n
ull or omitted, the event is always triggered when it reaches the selected eleme
nt.</param> |
| 1983 /// <param name="data" type="Anything">Data to be passed to the handler in
event.data when an event is triggered.</param> |
| 1984 /// <param name="handler(eventObject)" type="Function">A function to execu
te when the event is triggered. The value false is also allowed as a shorthand f
or a function that simply does return false.</param> |
| 1985 /// <returns type="jQuery" /> |
| 1986 /// </signature> |
| 1987 /// <signature> |
| 1988 /// <summary>Attach a handler to an event for the elements. The handler is
executed at most once per element.</summary> |
| 1989 /// <param name="events" type="PlainObject">An object in which the string
keys represent one or more space-separated event types and optional namespaces,
and the values represent a handler function to be called for the event(s).</para
m> |
| 1990 /// <param name="selector" type="String">A selector string to filter the d
escendants 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 el
ement.</param> |
| 1991 /// <param name="data" type="Anything">Data to be passed to the handler in
event.data when an event occurs.</param> |
| 1992 /// <returns type="jQuery" /> |
| 1993 /// </signature> |
| 1994 }, |
| 1995 'only-child': function() { |
| 1996 /// <summary>Selects all elements that are the only child of their parent.</
summary> |
| 1997 }, |
| 1998 'only-of-type': function() { |
| 1999 /// <summary>Selects all elements that have no siblings with the same elemen
t name.</summary> |
| 2000 }, |
| 2001 'outerHeight': function() { |
| 2002 /// <signature> |
| 2003 /// <summary>Get the current computed height for the first element in the
set of matched elements, including padding, border, and optionally margin. Retur
ns an integer (without "px") representation of the value or null if called on an
empty set of elements.</summary> |
| 2004 /// <param name="includeMargin" type="Boolean">A Boolean indicating whethe
r to include the element's margin in the calculation.</param> |
| 2005 /// <returns type="Number" /> |
| 2006 /// </signature> |
| 2007 }, |
| 2008 'outerWidth': function() { |
| 2009 /// <signature> |
| 2010 /// <summary>Get the current computed width for the first element in the s
et of matched elements, including padding and border.</summary> |
| 2011 /// <param name="includeMargin" type="Boolean">A Boolean indicating whethe
r to include the element's margin in the calculation.</param> |
| 2012 /// <returns type="Number" /> |
| 2013 /// </signature> |
| 2014 }, |
| 2015 'parent': function() { |
| 2016 /// <signature> |
| 2017 /// <summary>Get the parent of each element in the current set of matched
elements, optionally filtered by a selector.</summary> |
| 2018 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 2019 /// <returns type="jQuery" /> |
| 2020 /// </signature> |
| 2021 }, |
| 2022 'parents': function() { |
| 2023 /// <signature> |
| 2024 /// <summary>Get the ancestors of each element in the current set of match
ed elements, optionally filtered by a selector.</summary> |
| 2025 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 2026 /// <returns type="jQuery" /> |
| 2027 /// </signature> |
| 2028 }, |
| 2029 'parentsUntil': function() { |
| 2030 /// <signature> |
| 2031 /// <summary>Get the ancestors of each element in the current set of match
ed elements, up to but not including the element matched by the selector, DOM no
de, or jQuery object.</summary> |
| 2032 /// <param name="selector" type="String">A string containing a selector ex
pression to indicate where to stop matching ancestor elements.</param> |
| 2033 /// <param name="filter" type="String">A string containing a selector expr
ession to match elements against.</param> |
| 2034 /// <returns type="jQuery" /> |
| 2035 /// </signature> |
| 2036 /// <signature> |
| 2037 /// <summary>Get the ancestors of each element in the current set of match
ed elements, up to but not including the element matched by the selector, DOM no
de, or jQuery object.</summary> |
| 2038 /// <param name="element" type="Element">A DOM node or jQuery object indic
ating where to stop matching ancestor elements.</param> |
| 2039 /// <param name="filter" type="String">A string containing a selector expr
ession to match elements against.</param> |
| 2040 /// <returns type="jQuery" /> |
| 2041 /// </signature> |
| 2042 }, |
| 2043 'password': function() { |
| 2044 /// <summary>Selects all elements of type password.</summary> |
| 2045 }, |
| 2046 'position': function() { |
| 2047 /// <summary>Get the current coordinates of the first element in the set of
matched elements, relative to the offset parent.</summary> |
| 2048 /// <returns type="Object" /> |
| 2049 }, |
| 2050 'prepend': function() { |
| 2051 /// <signature> |
| 2052 /// <summary>Insert content, specified by the parameter, to the beginning
of each element in the set of matched elements.</summary> |
| 2053 /// <param name="content" type="">DOM element, array of elements, HTML str
ing, or jQuery object to insert at the beginning of each element in the set of m
atched elements.</param> |
| 2054 /// <param name="content" type="">One or more additional DOM elements, arr
ays of elements, HTML strings, or jQuery objects to insert at the beginning of e
ach element in the set of matched elements.</param> |
| 2055 /// <returns type="jQuery" /> |
| 2056 /// </signature> |
| 2057 /// <signature> |
| 2058 /// <summary>Insert content, specified by the parameter, to the beginning
of each element in the set of matched elements.</summary> |
| 2059 /// <param name="function(index, html)" type="Function">A function that re
turns an HTML string, DOM element(s), or jQuery object to insert at the beginnin
g 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. With
in the function, this refers to the current element in the set.</param> |
| 2060 /// <returns type="jQuery" /> |
| 2061 /// </signature> |
| 2062 }, |
| 2063 'prependTo': function() { |
| 2064 /// <signature> |
| 2065 /// <summary>Insert every element in the set of matched elements to the be
ginning of the target.</summary> |
| 2066 /// <param name="target" type="">A selector, element, HTML string, or jQue
ry object; the matched set of elements will be inserted at the beginning of the
element(s) specified by this parameter.</param> |
| 2067 /// <returns type="jQuery" /> |
| 2068 /// </signature> |
| 2069 }, |
| 2070 'prev': function() { |
| 2071 /// <signature> |
| 2072 /// <summary>Get the immediately preceding sibling of each element in the
set of matched elements, optionally filtered by a selector.</summary> |
| 2073 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 2074 /// <returns type="jQuery" /> |
| 2075 /// </signature> |
| 2076 }, |
| 2077 'prevAll': function() { |
| 2078 /// <signature> |
| 2079 /// <summary>Get all preceding siblings of each element in the set of matc
hed elements, optionally filtered by a selector.</summary> |
| 2080 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 2081 /// <returns type="jQuery" /> |
| 2082 /// </signature> |
| 2083 }, |
| 2084 'prevUntil': function() { |
| 2085 /// <signature> |
| 2086 /// <summary>Get all preceding siblings of each element up to but not incl
uding the element matched by the selector, DOM node, or jQuery object.</summary> |
| 2087 /// <param name="selector" type="String">A string containing a selector ex
pression to indicate where to stop matching preceding sibling elements.</param> |
| 2088 /// <param name="filter" type="String">A string containing a selector expr
ession to match elements against.</param> |
| 2089 /// <returns type="jQuery" /> |
| 2090 /// </signature> |
| 2091 /// <signature> |
| 2092 /// <summary>Get all preceding siblings of each element up to but not incl
uding the element matched by the selector, DOM node, or jQuery object.</summary> |
| 2093 /// <param name="element" type="Element">A DOM node or jQuery object indic
ating where to stop matching preceding sibling elements.</param> |
| 2094 /// <param name="filter" type="String">A string containing a selector expr
ession to match elements against.</param> |
| 2095 /// <returns type="jQuery" /> |
| 2096 /// </signature> |
| 2097 }, |
| 2098 'promise': function() { |
| 2099 /// <signature> |
| 2100 /// <summary>Return a Promise object to observe when all actions of a cert
ain type bound to the collection, queued or not, have finished.</summary> |
| 2101 /// <param name="type" type="String">The type of queue that needs to be ob
served.</param> |
| 2102 /// <param name="target" type="PlainObject">Object onto which the promise
methods have to be attached</param> |
| 2103 /// <returns type="Promise" /> |
| 2104 /// </signature> |
| 2105 }, |
| 2106 'prop': function() { |
| 2107 /// <signature> |
| 2108 /// <summary>Set one or more properties for the set of matched elements.</
summary> |
| 2109 /// <param name="propertyName" type="String">The name of the property to s
et.</param> |
| 2110 /// <param name="value" type="">A value to set for the property.</param> |
| 2111 /// <returns type="jQuery" /> |
| 2112 /// </signature> |
| 2113 /// <signature> |
| 2114 /// <summary>Set one or more properties for the set of matched elements.</
summary> |
| 2115 /// <param name="properties" type="PlainObject">An object of property-valu
e pairs to set.</param> |
| 2116 /// <returns type="jQuery" /> |
| 2117 /// </signature> |
| 2118 /// <signature> |
| 2119 /// <summary>Set one or more properties for the set of matched elements.</
summary> |
| 2120 /// <param name="propertyName" type="String">The name of the property to s
et.</param> |
| 2121 /// <param name="function(index, oldPropertyValue)" type="Function">A func
tion returning the value to set. Receives the index position of the element in t
he set and the old property value as arguments. Within the function, the keyword
this refers to the current element.</param> |
| 2122 /// <returns type="jQuery" /> |
| 2123 /// </signature> |
| 2124 }, |
| 2125 'pushStack': function() { |
| 2126 /// <signature> |
| 2127 /// <summary>Add a collection of DOM elements onto the jQuery stack.</summ
ary> |
| 2128 /// <param name="elements" type="Array">An array of elements to push onto
the stack and make into a new jQuery object.</param> |
| 2129 /// <returns type="jQuery" /> |
| 2130 /// </signature> |
| 2131 /// <signature> |
| 2132 /// <summary>Add a collection of DOM elements onto the jQuery stack.</summ
ary> |
| 2133 /// <param name="elements" type="Array">An array of elements to push onto
the stack and make into a new jQuery object.</param> |
| 2134 /// <param name="name" type="String">The name of a jQuery method that gene
rated the array of elements.</param> |
| 2135 /// <param name="arguments" type="Array">The arguments that were passed in
to the jQuery method (for serialization).</param> |
| 2136 /// <returns type="jQuery" /> |
| 2137 /// </signature> |
| 2138 }, |
| 2139 'queue': function() { |
| 2140 /// <signature> |
| 2141 /// <summary>Manipulate the queue of functions to be executed, once for ea
ch matched element.</summary> |
| 2142 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 2143 /// <param name="newQueue" type="Array">An array of functions to replace t
he current queue contents.</param> |
| 2144 /// <returns type="jQuery" /> |
| 2145 /// </signature> |
| 2146 /// <signature> |
| 2147 /// <summary>Manipulate the queue of functions to be executed, once for ea
ch matched element.</summary> |
| 2148 /// <param name="queueName" type="String">A string containing the name of
the queue. Defaults to fx, the standard effects queue.</param> |
| 2149 /// <param name="callback( next )" type="Function">The new function to add
to the queue, with a function to call that will dequeue the next item.</param> |
| 2150 /// <returns type="jQuery" /> |
| 2151 /// </signature> |
| 2152 }, |
| 2153 'radio': function() { |
| 2154 /// <summary>Selects all elements of type radio.</summary> |
| 2155 }, |
| 2156 'ready': function() { |
| 2157 /// <signature> |
| 2158 /// <summary>Specify a function to execute when the DOM is fully loaded.</
summary> |
| 2159 /// <param name="handler" type="Function">A function to execute after the
DOM is ready.</param> |
| 2160 /// <returns type="jQuery" /> |
| 2161 /// </signature> |
| 2162 }, |
| 2163 'remove': function() { |
| 2164 /// <signature> |
| 2165 /// <summary>Remove the set of matched elements from the DOM.</summary> |
| 2166 /// <param name="selector" type="String">A selector expression that filter
s the set of matched elements to be removed.</param> |
| 2167 /// <returns type="jQuery" /> |
| 2168 /// </signature> |
| 2169 }, |
| 2170 'removeAttr': function() { |
| 2171 /// <signature> |
| 2172 /// <summary>Remove an attribute from each element in the set of matched e
lements.</summary> |
| 2173 /// <param name="attributeName" type="String">An attribute to remove; as o
f version 1.7, it can be a space-separated list of attributes.</param> |
| 2174 /// <returns type="jQuery" /> |
| 2175 /// </signature> |
| 2176 }, |
| 2177 'removeClass': function() { |
| 2178 /// <signature> |
| 2179 /// <summary>Remove a single class, multiple classes, or all classes from
each element in the set of matched elements.</summary> |
| 2180 /// <param name="className" type="String">One or more space-separated clas
ses to be removed from the class attribute of each matched element.</param> |
| 2181 /// <returns type="jQuery" /> |
| 2182 /// </signature> |
| 2183 /// <signature> |
| 2184 /// <summary>Remove a single class, multiple classes, or all classes from
each element in the set of matched elements.</summary> |
| 2185 /// <param name="function(index, class)" type="Function">A function return
ing one or more space-separated class names to be removed. Receives the index po
sition of the element in the set and the old class value as arguments.</param> |
| 2186 /// <returns type="jQuery" /> |
| 2187 /// </signature> |
| 2188 }, |
| 2189 'removeData': function() { |
| 2190 /// <signature> |
| 2191 /// <summary>Remove a previously-stored piece of data.</summary> |
| 2192 /// <param name="name" type="String">A string naming the piece of data to
delete.</param> |
| 2193 /// <returns type="jQuery" /> |
| 2194 /// </signature> |
| 2195 /// <signature> |
| 2196 /// <summary>Remove a previously-stored piece of data.</summary> |
| 2197 /// <param name="list" type="">An array or space-separated string naming t
he pieces of data to delete.</param> |
| 2198 /// <returns type="jQuery" /> |
| 2199 /// </signature> |
| 2200 }, |
| 2201 'removeProp': function() { |
| 2202 /// <signature> |
| 2203 /// <summary>Remove a property for the set of matched elements.</summary> |
| 2204 /// <param name="propertyName" type="String">The name of the property to r
emove.</param> |
| 2205 /// <returns type="jQuery" /> |
| 2206 /// </signature> |
| 2207 }, |
| 2208 'replaceAll': function() { |
| 2209 /// <signature> |
| 2210 /// <summary>Replace each target element with the set of matched elements.
</summary> |
| 2211 /// <param name="target" type="">A selector string, jQuery object, or DOM
element reference indicating which element(s) to replace.</param> |
| 2212 /// <returns type="jQuery" /> |
| 2213 /// </signature> |
| 2214 }, |
| 2215 'replaceWith': function() { |
| 2216 /// <signature> |
| 2217 /// <summary>Replace each element in the set of matched elements with the
provided new content and return the set of elements that was removed.</summary> |
| 2218 /// <param name="newContent" type="">The content to insert. May be an HTML
string, DOM element, or jQuery object.</param> |
| 2219 /// <returns type="jQuery" /> |
| 2220 /// </signature> |
| 2221 /// <signature> |
| 2222 /// <summary>Replace each element in the set of matched elements with the
provided new content and return the set of elements that was removed.</summary> |
| 2223 /// <param name="function" type="Function">A function that returns content
with which to replace the set of matched elements.</param> |
| 2224 /// <returns type="jQuery" /> |
| 2225 /// </signature> |
| 2226 }, |
| 2227 'reset': function() { |
| 2228 /// <summary>Selects all elements of type reset.</summary> |
| 2229 }, |
| 2230 'resize': function() { |
| 2231 /// <signature> |
| 2232 /// <summary>Bind an event handler to the "resize" JavaScript event, or tr
igger that event on an element.</summary> |
| 2233 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2234 /// <returns type="jQuery" /> |
| 2235 /// </signature> |
| 2236 /// <signature> |
| 2237 /// <summary>Bind an event handler to the "resize" JavaScript event, or tr
igger that event on an element.</summary> |
| 2238 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 2239 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2240 /// <returns type="jQuery" /> |
| 2241 /// </signature> |
| 2242 }, |
| 2243 'root': function() { |
| 2244 /// <summary>Selects the element that is the root of the document.</summary> |
| 2245 }, |
| 2246 'scroll': function() { |
| 2247 /// <signature> |
| 2248 /// <summary>Bind an event handler to the "scroll" JavaScript event, or tr
igger that event on an element.</summary> |
| 2249 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2250 /// <returns type="jQuery" /> |
| 2251 /// </signature> |
| 2252 /// <signature> |
| 2253 /// <summary>Bind an event handler to the "scroll" JavaScript event, or tr
igger that event on an element.</summary> |
| 2254 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 2255 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2256 /// <returns type="jQuery" /> |
| 2257 /// </signature> |
| 2258 }, |
| 2259 'scrollLeft': function() { |
| 2260 /// <signature> |
| 2261 /// <summary>Set the current horizontal position of the scroll bar for eac
h of the set of matched elements.</summary> |
| 2262 /// <param name="value" type="Number">An integer indicating the new positi
on to set the scroll bar to.</param> |
| 2263 /// <returns type="jQuery" /> |
| 2264 /// </signature> |
| 2265 }, |
| 2266 'scrollTop': function() { |
| 2267 /// <signature> |
| 2268 /// <summary>Set the current vertical position of the scroll bar for each
of the set of matched elements.</summary> |
| 2269 /// <param name="value" type="Number">An integer indicating the new positi
on to set the scroll bar to.</param> |
| 2270 /// <returns type="jQuery" /> |
| 2271 /// </signature> |
| 2272 }, |
| 2273 'select': function() { |
| 2274 /// <signature> |
| 2275 /// <summary>Bind an event handler to the "select" JavaScript event, or tr
igger that event on an element.</summary> |
| 2276 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2277 /// <returns type="jQuery" /> |
| 2278 /// </signature> |
| 2279 /// <signature> |
| 2280 /// <summary>Bind an event handler to the "select" JavaScript event, or tr
igger that event on an element.</summary> |
| 2281 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 2282 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2283 /// <returns type="jQuery" /> |
| 2284 /// </signature> |
| 2285 }, |
| 2286 'selected': function() { |
| 2287 /// <summary>Selects all elements that are selected.</summary> |
| 2288 }, |
| 2289 'selector': function() { |
| 2290 /// <summary>A selector representing selector passed to jQuery(), if any, wh
en creating the original set.</summary> |
| 2291 /// <returns type="String" /> |
| 2292 }, |
| 2293 'serialize': function() { |
| 2294 /// <summary>Encode a set of form elements as a string for submission.</summ
ary> |
| 2295 /// <returns type="String" /> |
| 2296 }, |
| 2297 'serializeArray': function() { |
| 2298 /// <summary>Encode a set of form elements as an array of names and values.<
/summary> |
| 2299 /// <returns type="Array" /> |
| 2300 }, |
| 2301 'show': function() { |
| 2302 /// <signature> |
| 2303 /// <summary>Display the matched elements.</summary> |
| 2304 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2305 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2306 /// <returns type="jQuery" /> |
| 2307 /// </signature> |
| 2308 /// <signature> |
| 2309 /// <summary>Display the matched elements.</summary> |
| 2310 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 2311 /// <returns type="jQuery" /> |
| 2312 /// </signature> |
| 2313 /// <signature> |
| 2314 /// <summary>Display the matched elements.</summary> |
| 2315 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2316 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 2317 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2318 /// <returns type="jQuery" /> |
| 2319 /// </signature> |
| 2320 }, |
| 2321 'siblings': function() { |
| 2322 /// <signature> |
| 2323 /// <summary>Get the siblings of each element in the set of matched elemen
ts, optionally filtered by a selector.</summary> |
| 2324 /// <param name="selector" type="String">A string containing a selector ex
pression to match elements against.</param> |
| 2325 /// <returns type="jQuery" /> |
| 2326 /// </signature> |
| 2327 }, |
| 2328 'size': function() { |
| 2329 /// <summary>Return the number of elements in the jQuery object.</summary> |
| 2330 /// <returns type="Number" /> |
| 2331 }, |
| 2332 'slice': function() { |
| 2333 /// <signature> |
| 2334 /// <summary>Reduce the set of matched elements to a subset specified by a
range of indices.</summary> |
| 2335 /// <param name="start" type="Number">An integer indicating the 0-based po
sition at which the elements begin to be selected. If negative, it indicates an
offset from the end of the set.</param> |
| 2336 /// <param name="end" type="Number">An integer indicating the 0-based posi
tion at which the elements stop being selected. If negative, it indicates an off
set from the end of the set. If omitted, the range continues until the end of th
e set.</param> |
| 2337 /// <returns type="jQuery" /> |
| 2338 /// </signature> |
| 2339 }, |
| 2340 'slideDown': function() { |
| 2341 /// <signature> |
| 2342 /// <summary>Display the matched elements with a sliding motion.</summary> |
| 2343 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2344 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2345 /// <returns type="jQuery" /> |
| 2346 /// </signature> |
| 2347 /// <signature> |
| 2348 /// <summary>Display the matched elements with a sliding motion.</summary> |
| 2349 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 2350 /// <returns type="jQuery" /> |
| 2351 /// </signature> |
| 2352 /// <signature> |
| 2353 /// <summary>Display the matched elements with a sliding motion.</summary> |
| 2354 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2355 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 2356 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2357 /// <returns type="jQuery" /> |
| 2358 /// </signature> |
| 2359 }, |
| 2360 'slideToggle': function() { |
| 2361 /// <signature> |
| 2362 /// <summary>Display or hide the matched elements with a sliding motion.</
summary> |
| 2363 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2364 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2365 /// <returns type="jQuery" /> |
| 2366 /// </signature> |
| 2367 /// <signature> |
| 2368 /// <summary>Display or hide the matched elements with a sliding motion.</
summary> |
| 2369 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 2370 /// <returns type="jQuery" /> |
| 2371 /// </signature> |
| 2372 /// <signature> |
| 2373 /// <summary>Display or hide the matched elements with a sliding motion.</
summary> |
| 2374 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2375 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 2376 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2377 /// <returns type="jQuery" /> |
| 2378 /// </signature> |
| 2379 }, |
| 2380 'slideUp': function() { |
| 2381 /// <signature> |
| 2382 /// <summary>Hide the matched elements with a sliding motion.</summary> |
| 2383 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2384 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2385 /// <returns type="jQuery" /> |
| 2386 /// </signature> |
| 2387 /// <signature> |
| 2388 /// <summary>Hide the matched elements with a sliding motion.</summary> |
| 2389 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 2390 /// <returns type="jQuery" /> |
| 2391 /// </signature> |
| 2392 /// <signature> |
| 2393 /// <summary>Hide the matched elements with a sliding motion.</summary> |
| 2394 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2395 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 2396 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2397 /// <returns type="jQuery" /> |
| 2398 /// </signature> |
| 2399 }, |
| 2400 'stop': function() { |
| 2401 /// <signature> |
| 2402 /// <summary>Stop the currently-running animation on the matched elements.
</summary> |
| 2403 /// <param name="clearQueue" type="Boolean">A Boolean indicating whether t
o remove queued animation as well. Defaults to false.</param> |
| 2404 /// <param name="jumpToEnd" type="Boolean">A Boolean indicating whether to
complete the current animation immediately. Defaults to false.</param> |
| 2405 /// <returns type="jQuery" /> |
| 2406 /// </signature> |
| 2407 /// <signature> |
| 2408 /// <summary>Stop the currently-running animation on the matched elements.
</summary> |
| 2409 /// <param name="queue" type="String">The name of the queue in which to st
op animations.</param> |
| 2410 /// <param name="clearQueue" type="Boolean">A Boolean indicating whether t
o remove queued animation as well. Defaults to false.</param> |
| 2411 /// <param name="jumpToEnd" type="Boolean">A Boolean indicating whether to
complete the current animation immediately. Defaults to false.</param> |
| 2412 /// <returns type="jQuery" /> |
| 2413 /// </signature> |
| 2414 }, |
| 2415 'submit': function() { |
| 2416 /// <signature> |
| 2417 /// <summary>Bind an event handler to the "submit" JavaScript event, or tr
igger that event on an element.</summary> |
| 2418 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2419 /// <returns type="jQuery" /> |
| 2420 /// </signature> |
| 2421 /// <signature> |
| 2422 /// <summary>Bind an event handler to the "submit" JavaScript event, or tr
igger that event on an element.</summary> |
| 2423 /// <param name="eventData" type="PlainObject">An object containing data t
hat will be passed to the event handler.</param> |
| 2424 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2425 /// <returns type="jQuery" /> |
| 2426 /// </signature> |
| 2427 }, |
| 2428 'target': function() { |
| 2429 /// <summary>Selects the target element indicated by the fragment identifier
of the document's URI.</summary> |
| 2430 }, |
| 2431 'text': function() { |
| 2432 /// <signature> |
| 2433 /// <summary>Set the content of each element in the set of matched element
s to the specified text.</summary> |
| 2434 /// <param name="textString" type="String">A string of text to set as the
content of each matched element.</param> |
| 2435 /// <returns type="jQuery" /> |
| 2436 /// </signature> |
| 2437 /// <signature> |
| 2438 /// <summary>Set the content of each element in the set of matched element
s to the specified text.</summary> |
| 2439 /// <param name="function(index, text)" type="Function">A function returni
ng the text content to set. Receives the index position of the element in the se
t and the old text value as arguments.</param> |
| 2440 /// <returns type="jQuery" /> |
| 2441 /// </signature> |
| 2442 }, |
| 2443 'toArray': function() { |
| 2444 /// <summary>Retrieve all the DOM elements contained in the jQuery set, as a
n array.</summary> |
| 2445 /// <returns type="Array" /> |
| 2446 }, |
| 2447 'toggle': function() { |
| 2448 /// <signature> |
| 2449 /// <summary>Display or hide the matched elements.</summary> |
| 2450 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2451 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2452 /// <returns type="jQuery" /> |
| 2453 /// </signature> |
| 2454 /// <signature> |
| 2455 /// <summary>Display or hide the matched elements.</summary> |
| 2456 /// <param name="options" type="PlainObject">A map of additional options t
o pass to the method.</param> |
| 2457 /// <returns type="jQuery" /> |
| 2458 /// </signature> |
| 2459 /// <signature> |
| 2460 /// <summary>Display or hide the matched elements.</summary> |
| 2461 /// <param name="duration" type="">A string or number determining how long
the animation will run.</param> |
| 2462 /// <param name="easing" type="String">A string indicating which easing fu
nction to use for the transition.</param> |
| 2463 /// <param name="complete" type="Function">A function to call once the ani
mation is complete.</param> |
| 2464 /// <returns type="jQuery" /> |
| 2465 /// </signature> |
| 2466 /// <signature> |
| 2467 /// <summary>Display or hide the matched elements.</summary> |
| 2468 /// <param name="showOrHide" type="Boolean">A Boolean indicating whether t
o show or hide the elements.</param> |
| 2469 /// <returns type="jQuery" /> |
| 2470 /// </signature> |
| 2471 }, |
| 2472 'toggleClass': function() { |
| 2473 /// <signature> |
| 2474 /// <summary>Add or remove one or more classes from each element in the se
t of matched elements, depending on either the class's presence or the value of
the switch argument.</summary> |
| 2475 /// <param name="className" type="String">One or more class names (separat
ed by spaces) to be toggled for each element in the matched set.</param> |
| 2476 /// <returns type="jQuery" /> |
| 2477 /// </signature> |
| 2478 /// <signature> |
| 2479 /// <summary>Add or remove one or more classes from each element in the se
t of matched elements, depending on either the class's presence or the value of
the switch argument.</summary> |
| 2480 /// <param name="className" type="String">One or more class names (separat
ed by spaces) to be toggled for each element in the matched set.</param> |
| 2481 /// <param name="switch" type="Boolean">A Boolean (not just truthy/falsy)
value to determine whether the class should be added or removed.</param> |
| 2482 /// <returns type="jQuery" /> |
| 2483 /// </signature> |
| 2484 /// <signature> |
| 2485 /// <summary>Add or remove one or more classes from each element in the se
t of matched elements, depending on either the class's presence or the value of
the switch argument.</summary> |
| 2486 /// <param name="switch" type="Boolean">A boolean value to determine wheth
er the class should be added or removed.</param> |
| 2487 /// <returns type="jQuery" /> |
| 2488 /// </signature> |
| 2489 /// <signature> |
| 2490 /// <summary>Add or remove one or more classes from each element in the se
t of matched elements, depending on either the class's presence or the value of
the switch argument.</summary> |
| 2491 /// <param name="function(index, class, switch)" type="Function">A functio
n 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 o
ld class value, and the switch as arguments.</param> |
| 2492 /// <param name="switch" type="Boolean">A boolean value to determine wheth
er the class should be added or removed.</param> |
| 2493 /// <returns type="jQuery" /> |
| 2494 /// </signature> |
| 2495 }, |
| 2496 'trigger': function() { |
| 2497 /// <signature> |
| 2498 /// <summary>Execute all handlers and behaviors attached to the matched el
ements for the given event type.</summary> |
| 2499 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as click or submit.</param> |
| 2500 /// <param name="extraParameters" type="">Additional parameters to pass al
ong to the event handler.</param> |
| 2501 /// <returns type="jQuery" /> |
| 2502 /// </signature> |
| 2503 /// <signature> |
| 2504 /// <summary>Execute all handlers and behaviors attached to the matched el
ements for the given event type.</summary> |
| 2505 /// <param name="event" type="Event">A jQuery.Event object.</param> |
| 2506 /// <param name="extraParameters" type="">Additional parameters to pass al
ong to the event handler.</param> |
| 2507 /// <returns type="jQuery" /> |
| 2508 /// </signature> |
| 2509 }, |
| 2510 'triggerHandler': function() { |
| 2511 /// <signature> |
| 2512 /// <summary>Execute all handlers attached to an element for an event.</su
mmary> |
| 2513 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as click or submit.</param> |
| 2514 /// <param name="extraParameters" type="Array">An array of additional para
meters to pass along to the event handler.</param> |
| 2515 /// <returns type="Object" /> |
| 2516 /// </signature> |
| 2517 }, |
| 2518 'unbind': function() { |
| 2519 /// <signature> |
| 2520 /// <summary>Remove a previously-attached event handler from the elements.
</summary> |
| 2521 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as click or submit.</param> |
| 2522 /// <param name="handler(eventObject)" type="Function">The function that i
s to be no longer executed.</param> |
| 2523 /// <returns type="jQuery" /> |
| 2524 /// </signature> |
| 2525 /// <signature> |
| 2526 /// <summary>Remove a previously-attached event handler from the elements.
</summary> |
| 2527 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as click or submit.</param> |
| 2528 /// <param name="false" type="Boolean">Unbinds the corresponding 'return f
alse' function that was bound using .bind( eventType, false ).</param> |
| 2529 /// <returns type="jQuery" /> |
| 2530 /// </signature> |
| 2531 /// <signature> |
| 2532 /// <summary>Remove a previously-attached event handler from the elements.
</summary> |
| 2533 /// <param name="event" type="Object">A JavaScript event object as passed
to an event handler.</param> |
| 2534 /// <returns type="jQuery" /> |
| 2535 /// </signature> |
| 2536 }, |
| 2537 'undelegate': function() { |
| 2538 /// <signature> |
| 2539 /// <summary>Remove a handler from the event for all elements which match
the current selector, based upon a specific set of root elements.</summary> |
| 2540 /// <param name="selector" type="String">A selector which will be used to
filter the event results.</param> |
| 2541 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as "click" or "keydown"</param> |
| 2542 /// <returns type="jQuery" /> |
| 2543 /// </signature> |
| 2544 /// <signature> |
| 2545 /// <summary>Remove a handler from the event for all elements which match
the current selector, based upon a specific set of root elements.</summary> |
| 2546 /// <param name="selector" type="String">A selector which will be used to
filter the event results.</param> |
| 2547 /// <param name="eventType" type="String">A string containing a JavaScript
event type, such as "click" or "keydown"</param> |
| 2548 /// <param name="handler(eventObject)" type="Function">A function to execu
te at the time the event is triggered.</param> |
| 2549 /// <returns type="jQuery" /> |
| 2550 /// </signature> |
| 2551 /// <signature> |
| 2552 /// <summary>Remove a handler from the event for all elements which match
the current selector, based upon a specific set of root elements.</summary> |
| 2553 /// <param name="selector" type="String">A selector which will be used to
filter the event results.</param> |
| 2554 /// <param name="events" type="PlainObject">An object of one or more event
types and previously bound functions to unbind from them.</param> |
| 2555 /// <returns type="jQuery" /> |
| 2556 /// </signature> |
| 2557 /// <signature> |
| 2558 /// <summary>Remove a handler from the event for all elements which match
the current selector, based upon a specific set of root elements.</summary> |
| 2559 /// <param name="namespace" type="String">A string containing a namespace
to unbind all events from.</param> |
| 2560 /// <returns type="jQuery" /> |
| 2561 /// </signature> |
| 2562 }, |
| 2563 'unload': function() { |
| 2564 /// <signature> |
| 2565 /// <summary>Bind an event handler to the "unload" JavaScript event.</summ
ary> |
| 2566 /// <param name="handler(eventObject)" type="Function">A function to execu
te when the event is triggered.</param> |
| 2567 /// <returns type="jQuery" /> |
| 2568 /// </signature> |
| 2569 /// <signature> |
| 2570 /// <summary>Bind an event handler to the "unload" JavaScript event.</summ
ary> |
| 2571 /// <param name="eventData" type="Object">A plain object of data that will
be passed to the event handler.</param> |
| 2572 /// <param name="handler(eventObject)" type="Function">A function to execu
te each time the event is triggered.</param> |
| 2573 /// <returns type="jQuery" /> |
| 2574 /// </signature> |
| 2575 }, |
| 2576 'unwrap': function() { |
| 2577 /// <summary>Remove the parents of the set of matched elements from the DOM,
leaving the matched elements in their place.</summary> |
| 2578 /// <returns type="jQuery" /> |
| 2579 }, |
| 2580 'val': function() { |
| 2581 /// <signature> |
| 2582 /// <summary>Set the value of each element in the set of matched elements.
</summary> |
| 2583 /// <param name="value" type="">A string of text or an array of strings co
rresponding to the value of each matched element to set as selected/checked.</pa
ram> |
| 2584 /// <returns type="jQuery" /> |
| 2585 /// </signature> |
| 2586 /// <signature> |
| 2587 /// <summary>Set the value of each element in the set of matched elements.
</summary> |
| 2588 /// <param name="function(index, value)" type="Function">A function return
ing the value to set. this is the current element. Receives the index position o
f the element in the set and the old value as arguments.</param> |
| 2589 /// <returns type="jQuery" /> |
| 2590 /// </signature> |
| 2591 }, |
| 2592 'visible': function() { |
| 2593 /// <summary>Selects all elements that are visible.</summary> |
| 2594 }, |
| 2595 'width': function() { |
| 2596 /// <signature> |
| 2597 /// <summary>Set the CSS width of each element in the set of matched eleme
nts.</summary> |
| 2598 /// <param name="value" type="">An integer representing the number of pixe
ls, or an integer along with an optional unit of measure appended (as a string).
</param> |
| 2599 /// <returns type="jQuery" /> |
| 2600 /// </signature> |
| 2601 /// <signature> |
| 2602 /// <summary>Set the CSS width of each element in the set of matched eleme
nts.</summary> |
| 2603 /// <param name="function(index, width)" type="Function">A function return
ing 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 elem
ent in the set.</param> |
| 2604 /// <returns type="jQuery" /> |
| 2605 /// </signature> |
| 2606 }, |
| 2607 'wrap': function() { |
| 2608 /// <signature> |
| 2609 /// <summary>Wrap an HTML structure around each element in the set of matc
hed elements.</summary> |
| 2610 /// <param name="wrappingElement" type="">A selector, element, HTML string
, or jQuery object specifying the structure to wrap around the matched elements.
</param> |
| 2611 /// <returns type="jQuery" /> |
| 2612 /// </signature> |
| 2613 /// <signature> |
| 2614 /// <summary>Wrap an HTML structure around each element in the set of matc
hed elements.</summary> |
| 2615 /// <param name="function(index)" type="Function">A callback function retu
rning the HTML content or jQuery object to wrap around the matched elements. Rec
eives the index position of the element in the set as an argument. Within the fu
nction, this refers to the current element in the set.</param> |
| 2616 /// <returns type="jQuery" /> |
| 2617 /// </signature> |
| 2618 }, |
| 2619 'wrapAll': function() { |
| 2620 /// <signature> |
| 2621 /// <summary>Wrap an HTML structure around all elements in the set of matc
hed elements.</summary> |
| 2622 /// <param name="wrappingElement" type="">A selector, element, HTML string
, or jQuery object specifying the structure to wrap around the matched elements.
</param> |
| 2623 /// <returns type="jQuery" /> |
| 2624 /// </signature> |
| 2625 }, |
| 2626 'wrapInner': function() { |
| 2627 /// <signature> |
| 2628 /// <summary>Wrap an HTML structure around the content of each element in
the set of matched elements.</summary> |
| 2629 /// <param name="wrappingElement" type="String">An HTML snippet, selector
expression, jQuery object, or DOM element specifying the structure to wrap aroun
d the content of the matched elements.</param> |
| 2630 /// <returns type="jQuery" /> |
| 2631 /// </signature> |
| 2632 /// <signature> |
| 2633 /// <summary>Wrap an HTML structure around the content of each element in
the set of matched elements.</summary> |
| 2634 /// <param name="function(index)" type="Function">A callback function whic
h generates a structure to wrap around the content of the matched elements. Rece
ives the index position of the element in the set as an argument. Within the fun
ction, this refers to the current element in the set.</param> |
| 2635 /// <returns type="jQuery" /> |
| 2636 /// </signature> |
| 2637 }, |
| 2638 }); |
| 2639 |
| 2640 intellisense.annotate(window, { |
| 2641 '$': function() { |
| 2642 /// <signature> |
| 2643 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 2644 /// <param name="selector" type="String">A string containing a selector ex
pression</param> |
| 2645 /// <param name="context" type="">A DOM Element, Document, or jQuery to us
e as context</param> |
| 2646 /// <returns type="jQuery" /> |
| 2647 /// </signature> |
| 2648 /// <signature> |
| 2649 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 2650 /// <param name="element" type="Element">A DOM element to wrap in a jQuery
object.</param> |
| 2651 /// <returns type="jQuery" /> |
| 2652 /// </signature> |
| 2653 /// <signature> |
| 2654 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 2655 /// <param name="elementArray" type="Array">An array containing a set of D
OM elements to wrap in a jQuery object.</param> |
| 2656 /// <returns type="jQuery" /> |
| 2657 /// </signature> |
| 2658 /// <signature> |
| 2659 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 2660 /// <param name="object" type="PlainObject">A plain object to wrap in a jQ
uery object.</param> |
| 2661 /// <returns type="jQuery" /> |
| 2662 /// </signature> |
| 2663 /// <signature> |
| 2664 /// <summary>Accepts a string containing a CSS selector which is then used
to match a set of elements.</summary> |
| 2665 /// <param name="jQuery object" type="PlainObject">An existing jQuery obje
ct to clone.</param> |
| 2666 /// <returns type="jQuery" /> |
| 2667 /// </signature> |
| 2668 }, |
| 2669 }); |
| 2670 |
OLD | NEW |