📄 jquery.sdoc
字号:
/**
* Scriptdoc-file for jQuery 1.2.3
*
* Created: Jan 25, 2007 19:31:20 GMT
* Courtesy of Edwin Martin
*
* Updated: July 12, 2007
* Updated by Michelle Petersen
*
* Updated: Oct 15, 2007
* Updated by Davey Waterson
*
* Updated: Feb 26, 2008
* Updated by Michelle Petersen
*/
/**
* This function accepts a string containing a CSS or basic XPath selector which is then used to match a set of elements.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>$</b>(<b>html</b>: String) : jQuery<br>
* <br>
* Create DOM elements on-the-fly from the provided String of raw HTML.<br>
* <br>
* <b>$</b>(<b>elems</b>: Element|Array) : jQuery<br>
* <br>
* Wrap jQuery functionality around a single or multiple DOM Element(s).<br>
* <br>
* <b>$</b>(<b>fn</b>: Function) : jQuery<br>
* <br>
* A shorthand for $(document).<br>
* <br>
* @id jQuery.$
* @alias $
* @alias jQuery
* @alias jQuery.prototype.$
* @param {String} expr
* @param {Element|jQuery} context
* @return {jQuery}
*/
function jQuery(){};
/**
* The current version of jQuery.
* @id jQuery.jquery
* @alias jQuery.prototype.jquery
* @return {String}
*/
function jQuery.jquery(){};
/**
* The number of elements in the jQuery object.
* @id jQuery.length
* @alias $.length
* @alias jQuery.prototype.length
* @return {Number}
*/
function jQuery().length(){};
/**
* The number of elements currently matched.
* @method
* @id jQuery.size
* @alias $.size
* @alias jQuery.prototype.size
* @return {Number}
*/
function jQuery.size(){};
/**
* Access all matched elements.
* or get a document via ajax
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>get</b>(<b>num</b>: Number) : Element<br>
* <br>
* Access a single matched element.<BR>
* <br>
* <b>get</b>(<b>url</b>: String, <b>data</b>: Map, <b>callback</b>: Function) : XMLHttpRequest
* <br><BR>
* This is an easy way to send a simple GET request to a server without having to use
* the more complex $.ajax function. <BR>
* It allows a single callback function to be specified that will be executed when
* the request is complete (and only if the response has a successful response code).
* <BR>If you need to have both error and success callbacks, you may want to use
* $.ajax.<br>
* <br>
* @id jQuery.get
* @alias $.get
* @alias jQuery.prototype.get
* @return {Array}
*/
function jQuery.get(){};
/**
* Set the jQuery object to an array of elements, while maintaining the stack.
* @id jQuery.pushStack
* @alias $.pushStack
* @alias jQuery.prototype.pushStack
* @param {Elements} elems
* @return {jQuery}
*/
function jQuery.pushStack(){};
/**
* Set the jQuery object to an array of elements.
* @id jQuery.setArray
* @alias $.setArray
* @alias jQuery.prototype.setArray
* @param {Elements} elems
* @return {jQuery}
*/
function jQuery.setArray(){};
/**
* Execute a function within the context of every matched element.
* @id jQuery.each
* @alias jQuery.prototype.each
* @param {Function} fn
* @return {jQuery}
*/
function jQuery.each(){};
/**
* Searches every matched element for the object and returns the index of the element, if found, starting with zero.
* @id jQuery.index
* @alias $.index
* @alias jQuery.prototype.index
* @param {Element} subject
* @return {Number}
*/
function jQuery.index(){};
/**
* Access a property on the first matched element.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>attr</b>(<b>properties</b>: Map) : jQuery<br>
* <br>
* Set a key/value object as properties to all matched elements.<br>
* <br>
* <b>attr</b>(<b>key</b>: String, <b>value</b>: Object) : jQuery<br>
* <br>
* Set a single property to a value, on all matched elements.<br>
* <br>
* <b>attr</b>(<b>key</b>: String, <b>value</b>: Function) : jQuery<br>
* <br>
* Set a single property to a computed value, on all matched elements.<br>
* <br>
* @id jQuery.attr
* @alias $.attr
* @alias jQuery.prototype.attr
* @param {String} name
* @return {Object}
*/
function jQuery.attr(){};
/**
* Access a style property on the first matched element.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>css</b>(<b>properties</b>: Map) : jQuery<br>
* <br>
* Set a key/value object as style properties to all matched elements.<br>
* <br>
* <b>css</b>(<b>key</b>: String, <b>value</b>: String|Number) : jQuery<br>
* <br>
* Set a single style property to a value, on all matched elements.<br>
* <br>
* @id jQuery.css
* @alias $.css
* @alias jQuery.prototype.css
* @param {String} name
* @return {String}
*/
function jQuery.css(){};
/**
* Get the text contents of all matched elements.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>text</b>(<b>val</b>: String) : String<br>
* <br>
* Set the text contents of all matched elements.<br>
* <br>
* @id jQuery.text
* @alias $.text
* @alias jQuery.prototype.text
* @return {String}
*/
function jQuery.text(){};
/**
* Wrap all matched elements with a structure of other elements.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>wrap</b>(<b>elem</b>: Element) : jQuery<br>
* <br>
* Wrap all matched elements with a structure of other elements.<br>
* <br>
* @id jQuery.wrap
* @alias $.wrap
* @alias jQuery.prototype.wrap
* @param {String} html
* @return {jQuery}
*/
function jQuery.wrap(){};
/**
* Append content to the inside of every matched element.
* @id jQuery.append
* @alias $.append
* @alias jQuery.prototype.append
* @param {} content
* @return {jQuery}
*/
function jQuery.append(){};
/**
* Prepend content to the inside of every matched element.
* @id jQuery.prepend
* @alias $.prepend
* @alias jQuery.prototype.prepend
* @param {} content
* @return {jQuery}
*/
function jQuery.prepend(){};
/**
* Insert content before each of the matched elements.
* @id jQuery.before
* @alias $.before
* @alias jQuery.prototype.before
* @param {} content
* @return {jQuery}
*/
function jQuery.before(){};
/**
* Insert content after each of the matched elements.
* @id jQuery.after
* @alias $.after
* @alias jQuery.prototype.after
* @param {} content
* @return {jQuery}
*/
function jQuery.after(){};
/**
* End the most recent 'destructive' operation, reverting the list of matched elements back to its previous state.
* @id jQuery.end
* @alias $.end
* @alias jQuery.prototype.end
* @return {jQuery}
*/
function jQuery.end(){};
/**
* Searches for all elements that match the specified expression.
* @id jQuery.find
* @alias $.find
* @alias jQuery.prototype.find
* @param {String} expr
* @return {jQuery}
*/
function jQuery.find(){};
/**
* Clone matched DOM Elements and select the clones.<BR>
* <BR>
* Calling the clone method with an argument
* is being deprecated (the clone method, as a whole, is being kept). <BR>
* <BR>
* Instead of calling <B>.clone(false)</B> you should now do: <b>.clone().empty()</B> instead.
* @id jQuery.clone
* @alias $.clone
* @alias jQuery.prototype.clone
* @return {jQuery}
*/
function jQuery.clone(){};
/**
* Removes all elements from the set of matched elements that do not match the specified expression(s).
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>filter</b>(<b>filter</b>: Function) : jQuery<br>
* <br>
* Removes all elements from the set of matched elements that do not pass the specified filter.<br>
* <br>
* @id jQuery.filter
* @alias $.filter
* @alias jQuery.prototype.filter
* @param {String} expression
* @return {jQuery}
*/
function jQuery.filter(){};
/**
* Removes the specified Element from the set of matched elements.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>not</b>(<b>expr</b>: String) : jQuery<br>
* <br>
* Removes elements matching the specified expression from the set of matched elements.<br>
* <br>
* <b>not</b>(<b>elems</b>: jQuery) : jQuery<br>
* <br>
* Removes any elements inside the array of elements from the set of matched elements.<br>
* <br>
* @id jQuery.not
* @alias $.not
* @alias jQuery.prototype.not
* @param {Element} el
* @return {jQuery}
*/
function jQuery.not(){};
/**
* Adds more elements, matched by the given expression, to the set of matched elements.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>add</b>(<b>html</b>: String) : jQuery<br>
* <br>
* Adds more elements, created on the fly, to the set of matched elements.<br>
* <br>
* <b>add</b>(<b>elements</b>: Element|Array) : jQuery<br>
* <br>
* Adds one or more Elements to the set of matched elements.<br>
* <br>
* @id jQuery.add
* @alias $.add
* @alias jQuery.prototype.add
* @param {String} expr
* @return {jQuery}
*/
function jQuery.add(){};
/**
* Checks the current selection against an expression and returns true, if at least one element of the selection fits the given expression.
* @id jQuery.is
* @alias $.is
* @alias jQuery.prototype.is
* @param {String} expr
* @return {Boolean}
*/
function jQuery.is(){};
/**
* Get the current value of the first matched element.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>val</b>(<b>val</b>: String) : jQuery<br>
* <br>
* Set the value of every matched element.<br>
* <br>
* @id jQuery.val
* @alias $.val
* @alias jQuery.prototype.val
* @return {String}
*/
function jQuery.val(){};
/**
* Get the html contents of the first matched element.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>html</b>(<b>val</b>: String) : jQuery<br>
* <br>
* Set the html contents of every matched element.<br>
* <br>
* @id jQuery.html
* @alias $.html
* @alias jQuery.prototype.html
* @return {String}
*/
function jQuery.html(){};
/**
* @id jQuery.domManip
* @alias $.domManip
* @alias jQuery.prototype.domManip
* @param {Array} args
* @param {Boolean} table
* @param {Number} dir
* @param {Function} fn
* @return {jQuery}
*/
function jQuery.domManip(){};
/**
* Extends the jQuery object itself.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>$.extend</b>(<b>target</b>: Object, <b>prop1</b>: Object, <b>propN</b>: Object) : Object<br>
* <br>
* Extend one object with one or more others, returning the original, modified, object.<br>
* <br>
* @id jQuery.$.extend
* @alias $.extend
* @param {Object} prop
* @return {Object}
*/
function jQuery.extend(){};
/**
* Run this function to give control of the $ variable back to whichever library first implemented it.
* <br>
* <br><b>Alternatives</b><br>
* <br>
* <b>$.noConflict</b>(<b>extreme</b>) : jQuery<br>
* <BR>Revert control of both the $ and jQuery variables to their original owners.
* <B>Use with discretion.</B>
* <BR>This is a more-extreme version of the simple noConflict method,
* as this one will completely undo what jQuery has introduced. This is to be
* used in an extreme case where you'd like to embed jQuery into a high-conflict
* environment.
* <BR><B>NOTE:</B> It's very likely that plugins won't work after this particular
* method has been called.
* @id jQuery.$.noConflict
* @alias $.noConflict
* @return {jQuery}
*/
function jQuery.noConflict(){};
/**
* A generic iterator function, which can be used to seemlessly iterate over both objects and arrays.
* @id jQuery.$.each
* @alias $.each
* @param {Object} obj
* @param {Function} fn
* @return {Object}
*/
function jQuery.each(){};
/**
* Remove the whitespace from the beginning and end of a string.
* @id jQuery.$.trim
* @alias $.trim
* @param {String} str
* @return {String}
*/
function jQuery.trim(){};
/**
* Merge two arrays together, removing all duplicates.
* @id jQuery.$.merge
* @alias $.merge
* @param {Array} first
* @param {Array} second
* @return {Array}
*/
function jQuery.merge(){};
/**
* Filter items out of an array, by using a filter function.
* @id jQuery.$.grep
* @alias $.grep
* @param {Array} array
* @param {Function} fn
* @param {Boolean} inv
* @return {Array}
*/
function jQuery.grep(){};
/**
* Translate all items in an array to another array of items.
* @id jQuery.$.map
* @alias $.map
* @param {Array} array
* @param {Function} fn
* @return {Array}
*/
function jQuery.map(){};
/**
* Contains flags for the useragent, read from navigator.
* @id jQuery.$.browser
* @alias $.browser
* @return {Boolean}
*/
function jQuery.browser(){};
/**
* Get a set of elements containing the unique parents of the matched set of elements.
* @id jQuery.parent
* @alias jQuery.prototype.parent
* @alias $.parent
* @param {String} expr
* @return {jQuery}
*/
function jQuery.parent(){};
/**
* Get a set of elements containing the unique ancestors of the matched set of elements (except for the root element).
* @id jQuery.parents
* @alias jQuery.prototype.parents
* @param {String} expr
* @return {jQuery}
*/
function jQuery.parents(){};
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -