Class Query

Holds a collection of elements returned from ample.query() function call.

Members Table

The following table lists the members exposed by the Query object.

Show inherited members (marked with *)

Show: Properties Methods

Attribute Description Property Type Readonly Description context Node true Holds the context of the selection query executed. length Number true Holds the length of the collection returned. resolver Function true Holds the namespace resolver function used to resolve namespaces in the selection query. selector String true Holds the CSS selector used in selection query. Method Returns Description abort Query Aborts loading operation. Sytaxis: object.abort() after Query Inserts content, specified by the parameter, after each element in the set of matched elements. Sytaxis: object.after(content) Arguments: Name Type O/R Description content Variant Required An element, XML string, or Query object to insert. animate Query Perform an animation of a set of CSS properties. Sytaxis: object.animate(properties, [duration, easing, callback]) Arguments: Name Type O/R Description properties Object Required A hash of CSS properties that the animation will move toward. duration Variant Optional A string or number determining how long the animation will run. easing Variant Optional A string indicating which easing function to use for the transition. callback Function Optional A function to call once the animation is complete. append Query Inserts content, specified by the parameter, to the end of each element in the set of matched elements. Sytaxis: object.append(content) Arguments: Name Type O/R Description content Variant Required An element, XML string, or Query object to insert. appendTo Query Inserts every element in the set of matched elements to the end of the target. Sytaxis: object.appendTo(target) Arguments: Name Type O/R Description target Variant Required An element, selector, XML string, or Query object. attr Variant Gets the value of an attribute for the first element in the set of matched elements or sets the value of an ttribute for the set of matched elements. Sytaxis: object.attr(name) Arguments: Name Type O/R Description name String Required Name of the attribute. Sytaxis: (2) object.attr(name, value) Arguments: Name Type O/R Description name String Required Name of the attribute. value String Required String value to be set. before Query Inserts content, specified by the parameter, before each element in the set of matched elements. Sytaxis: object.before(content) Arguments: Name Type O/R Description content Variant Required An element, XML string, or Query object to insert. bind Query Registers a handler with every element in set Sytaxis: object.bind(type, handler, [capture]) Arguments: Name Type O/R Description type String Required Event name handler Function Required Handler function capture Boolean Optional If true, the handler will be executed during capture phase only clone Query Creates a deep copy of the set of matched elements. No event handlers either data associated with element will be copied. Sytaxis: object.clone() css Variant Gets the value of a style property for the first element in the set of matched elements or set the value of a CSS property for the set of matched elements. Sytaxis: object.css(name) Arguments: Name Type O/R Description name String Required CSS property name. Sytaxis: (2) object.css(name, value) Arguments: Name Type O/R Description name String Required CSS property name. value String Required CSS property name. data Variant Gets value at named data store for the first element in the collection or sets arbitrary data associated with the matched elements. Sytaxis: object.data(name) Arguments: Name Type O/R Description name String Required A string key name. Sytaxis: (2) object.data(name, value) Arguments: Name Type O/R Description name String Required A string key name. value Variant Required The data value. delay Query Sets a timer to delay execution of subsequent animations. Sytaxis: object.delay(duration) Arguments: Name Type O/R Description duration Variant Required A string or number determining how long the delay will run. each Query Iterates over a collection, executing a function for each element. Sytaxis: object.each(callback) Arguments: Name Type O/R Description callback Function Required A callback function. empty Query Removes all child nodes of the set of matched elements from the DOM. Sytaxis: object.empty() eq Element Reduces the set of matched elements to the one at the specified index. Sytaxis: object.eq(index) Arguments: Name Type O/R Description index Number Required An integer indicating the 0-based position of the element. Negative values count backwards from the last element in the set. fadeIn Query Reveals the matched elements by fading them to opaque. Sytaxis: object.fadeIn([duration, callback]) Arguments: Name Type O/R Description duration Variant Optional A string or number determining how long the animation will run. callback Function Optional A function to call once the animation is complete. fadeOut Query Hides the matched elements by fading them to transparent. Sytaxis: object.fadeOut([duration, callback]) Arguments: Name Type O/R Description duration Variant Optional A string or number determining how long the animation will run. callback Function Optional A function to call once the animation is complete. fadeTo Query Adjusts the opacity of the matched elements. Sytaxis: object.fadeTo(duration, opacity, [callback]) Arguments: Name Type O/R Description duration Variant Required A string or number determining how long the animation will run. opacity Number Required A number between 0 and 1 denoting the target opacity. callback Function Optional A function to call once the animation is complete. first Query Reduces the set of matched elements to the first in the set. Sytaxis: object.first() get Variant Retrieves the element matched. Sytaxis: object.get(index) Arguments: Name Type O/R Description index Number Required A zero-based integer indicating which element to retrieve. has Query Reduces the set of matched elements to those that have a descendant that matches the selector or element. Sytaxis: object.has(selector) Arguments: Name Type O/R Description selector String Required A string containing a selector expression to match elements against. Sytaxis: (2) object.has(element) Arguments: Name Type O/R Description element Element Required An element to match elements against. height Variant Gets the current computed height for the first element in the set of matched elements or sets the CSS height of every matched element. Sytaxis: object.height() Sytaxis: (2) object.height(value) Arguments: Name Type O/R Description value Object Required An integer representing the number of pixels, or an integer with an optional unit of measure appended. hide Query Hides the matched elements. When no duration provided the matched elements will be hidden immediately, with no animation. Sytaxis: object.hide([duration, callback]) Arguments: Name Type O/R Description duration Variant Optional A string or number determining how long the animation will run. callback Function Optional A function to call once the animation is complete. html Variant Gets or sets the HTML contents of the first element in the set of matched elements. Sytaxis: object.html() Sytaxis: (2) object.html(html) Arguments: Name Type O/R Description html String Required A string of HTML. innerHeight Number Gets the current computed height for the first element in the set of matched elements, including padding but not border. Sytaxis: object.innerHeight() innerWidth Number Gets the current computed width for the first element in the set of matched elements, including padding but not border. Sytaxis: object.innerWidth() insertAfter Query Inserts every element in the set of matched elements after the target. Sytaxis: object.insertAfter(target) Arguments: Name Type O/R Description target Variant Required An element, selector, XML string, or Query object. insertBefore Query Inserts every element in the set of matched elements before the target. Sytaxis: object.insertBefore(target) Arguments: Name Type O/R Description target Variant Required An element, selector, XML string, or Query object. last Query Reduces the set of matched elements to the last in the set. Sytaxis: object.last() load Query Loads data from the server and places it to the first element matched. Sytaxis: object.load(url, [data, complete]) Arguments: Name Type O/R Description url String Required A string containing the URL to which the request is sent. data Object Optional Data to be sent with request. complete Function Optional Function to be executed on request completion. offset Variant Gets the current coordinates of the first element in the set of matched elements, relative to the document or sets the current coordinates of every element in the set of matched elements, relative to the document. Sytaxis: object.offset() Sytaxis: (2) object.offset(coordinates) Arguments: Name Type O/R Description coordinates Object Required An object containing the properties top and left, which are integers. offsetParent Element Gets the closest ancestor element that is positioned. Sytaxis: object.offsetParent() outerHeight Number Gets the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. Sytaxis: object.outerHeight() outerWidth Number Gets the current computed width for the first element in the set of matched elements, including padding, border, and optionally margin. Sytaxis: object.outerWidth() position Object Gets the current coordinates of the first element in the set of matched elements, relative to the offset parent. Return object contains the properties top and left. Sytaxis: object.position() prepend Query Inserts content, specified by the parameter, to the beginning of each element in the set of matched elements. Sytaxis: object.prepend(content) Arguments: Name Type O/R Description content Variant Required An element, XML string, or Query object to insert. prependTo Query Inserts every element in the set of matched elements to the beginning of the target. Sytaxis: object.prependTo(target) Arguments: Name Type O/R Description target Variant Required An element, selector, XML string, or Query object. remove Query Removes the set of matched elements from the DOM. Sytaxis: object.remove() replaceAll Query Replaces each target element with the set of matched elements. Sytaxis: object.replaceAll() replaceWith Query Replaces each element in the set of matched elements with the provided new content. Sytaxis: object.replaceWith(content) Arguments: Name Type O/R Description content Variant Required An element, XML string, or Query object to insert. scrollLeft Variant Gets the current horizontal position of the scroll bar for the first element in the set of matched elements or sets the current horizontal position of the scroll bar for each of the set of matched elements. Sytaxis: object.scrollLeft() Sytaxis: (2) object.scrollLeft(value) Arguments: Name Type O/R Description value Number Required An integer indicating the new position to set the scroll bar to. scrollTop Variant Gets the current vertical position of the scroll bar for the first element in the set of matched elements or sets the current vertical position of the scroll bar for each of the set of matched elements. Sytaxis: object.scrollTop() Sytaxis: (2) object.scrollTop(value) Arguments: Name Type O/R Description value Number Required An integer indicating the new position to set the scroll bar to. show Query Reveals the matched elements. When no duration provided the matched elements will be revealed immediately, with no animation. Sytaxis: object.show([duration, callback]) Arguments: Name Type O/R Description duration Variant Optional A string or number determining how long the animation will run. callback Function Optional A function to call once the animation is complete. size Number Returns the number of elements in the Query collection. Sytaxis: object.size() slice Query Reduces the set of matched elements to a subset specified by a range of indices. Sytaxis: object.slice(first, [last]) Arguments: Name Type O/R Description first Number Required An integer that specifies where to start the selection (The first element has an index of 0). You can also use negative numbers to select from the end of a collection. last Number Optional An integer that specifies where to end the selection. If omitted, slice() selects all elements from the start position and to the end of the collection. slideDown Query Reveals the matched elements with a sliding motion. Sytaxis: object.slideDown([duration, callback]) Arguments: Name Type O/R Description duration Variant Optional A string or number determining how long the animation will run. callback Function Optional A function to call once the animation is complete. slideUp Query Hides the matched elements with a sliding motion. Sytaxis: object.slideUp([duration, callback]) Arguments: Name Type O/R Description duration Variant Optional A string or number determining how long the animation will run. callback Function Optional A function to call once the animation is complete. splice Query Adds and/or removes elements to/from a collection, and returns the removed element(s). Sytaxis: object.splice(first, [length]) Arguments: Name Type O/R Description first Number Required An integer that specifies at what position to add/remove elements. length Number Optional The number of elements to be removed. If set to 0, no elements will be removed. stop Query Stops all animations running on elements in the set. Sytaxis: object.stop() text Variant Gets the combined text contents of each element in the set of matched elements, including their descendants or sets the content of each element in the set of matched elements to the specified text. Sytaxis: object.text() Sytaxis: (2) object.text(value) Arguments: Name Type O/R Description value String Required A string of text. toArray Array Retrieve all the elements contained in the Query collection, as an array. Sytaxis: object.toArray() trigger Query Triggers an event on every element in set. Sytaxis: object.trigger(type, [detail]) Arguments: Name Type O/R Description type String Required Event name detail Variant Optional Event detail unbind Query Unregisters a handler from every element in set Sytaxis: object.unbind(type, handler, [capture]) Arguments: Name Type O/R Description type String Required Event name handler Function Required Handler function capture Boolean Optional If true, the handler will be executed during capture phase only width Variant Gets the current computed width for the first element in the set of matched elements or sets the CSS width of every matched element. Sytaxis: object.width() Sytaxis: (2) object.width(value) Arguments: Name Type O/R Description value Object Required An integer representing the number of pixels, or an integer with an optional unit of measure appended. Event B C Interface Description Pseudo-class Description Constant Value Description