Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDocumentService

Hierarchy

  • JQuery
    • IDocumentService

Indexable

[index: number]: HTMLElement

Index

Properties

context

context: Element

The DOM node context originally passed to jQuery(); if none was passed then context will likely be the document. (DEPRECATED from v1.10)

jquery

jquery: string

length

length: number

The number of elements in the jQuery object.

selector

selector: string

A selector representing selector passed to jQuery(), if any, when creating the original set. version deprecated: 1.7, removed: 1.9

Methods

add

  • add(selector: string, context?: Element): JQuery
  • add(...elements: Element[]): JQuery
  • add(html: string): JQuery
  • add(obj: JQuery): JQuery
  • Add elements to the set of matched elements.

    Parameters

    • selector: string

      A string representing a selector expression to find additional elements to add to the set of matched elements.

    • Optional context: Element

      The point in the document at which the selector should begin matching; similar to the context argument of the $(selector, context) method.

    Returns JQuery

  • Add elements to the set of matched elements.

    Parameters

    • Rest ...elements: Element[]

      One or more elements to add to the set of matched elements.

    Returns JQuery

  • Add elements to the set of matched elements.

    Parameters

    • html: string

      An HTML fragment to add to the set of matched elements.

    Returns JQuery

  • Add elements to the set of matched elements.

    Parameters

    • obj: JQuery

      An existing jQuery object to add to the set of matched elements.

    Returns JQuery

addBack

  • addBack(selector?: string): JQuery
  • Add the previous set of elements on the stack to the current set, optionally filtered by a selector.

    Parameters

    • Optional selector: string

    Returns JQuery

addClass

  • addClass(className: string): JQuery
  • addClass(func: function): JQuery
  • Adds the specified class(es) to each of the set of matched elements.

    Parameters

    • className: string

      One or more space-separated classes to be added to the class attribute of each matched element.

    Returns JQuery

  • Adds the specified class(es) to each of the set of matched elements.

    Parameters

    • func: function
        • (index: number, className: string): string
        • Parameters

          • index: number
          • className: string

          Returns string

    Returns JQuery

after

  • after(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • after(func: function): JQuery
  • Insert content, specified by the parameter, after each element in the set of matched elements.

    param content1 HTML string, DOM element, DocumentFragment, array of elements, or jQuery object to insert after each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert after each element in the set of matched elements.

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string
    • Rest ...content2: any[]

    Returns JQuery

  • Insert content, specified by the parameter, after each element in the set of matched elements.

    param func A function that returns an HTML string, DOM element(s), or jQuery object to insert after each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.

    Parameters

    • func: function
        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

ajaxComplete

  • ajaxComplete(handler: function): JQuery
  • Register a handler to be called when Ajax requests complete. This is an AjaxEvent.

    Parameters

    • handler: function

      The function to be invoked.

        • Parameters

          Returns any

    Returns JQuery

ajaxError

  • ajaxError(handler: function): JQuery

ajaxSend

  • ajaxSend(handler: function): JQuery

ajaxStart

  • ajaxStart(handler: function): JQuery
  • Register a handler to be called when the first Ajax request begins. This is an Ajax Event.

    Parameters

    • handler: function

      The function to be invoked.

        • (): any
        • Returns any

    Returns JQuery

ajaxStop

  • ajaxStop(handler: function): JQuery
  • Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.

    Parameters

    • handler: function

      The function to be invoked.

        • (): any
        • Returns any

    Returns JQuery

ajaxSuccess

  • ajaxSuccess(handler: function): JQuery
  • Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.

    Parameters

    Returns JQuery

animate

  • animate(properties: Object, duration?: string | number, complete?: Function): JQuery
  • animate(properties: Object, duration?: string | number, easing?: string, complete?: Function): JQuery
  • animate(properties: Object, options: JQueryAnimationOptions): JQuery
  • Perform a custom animation of a set of CSS properties.

    Parameters

    • properties: Object

      An object of CSS properties and values that the animation will move toward.

    • Optional duration: string | number

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Perform a custom animation of a set of CSS properties.

    Parameters

    • properties: Object

      An object of CSS properties and values that the animation will move toward.

    • Optional duration: string | number

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition. (default: swing)

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Perform a custom animation of a set of CSS properties.

    Parameters

    • properties: Object

      An object of CSS properties and values that the animation will move toward.

    • options: JQueryAnimationOptions

      A map of additional options to pass to the method.

    Returns JQuery

append

  • append(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • append(func: function): JQuery
  • Insert content, specified by the parameter, to the end of each element in the set of matched elements.

    param content1 DOM element, DocumentFragment, array of elements, HTML string, or jQuery object to insert at the end of each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert at the end of each element in the set of matched elements.

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string
    • Rest ...content2: any[]

    Returns JQuery

  • Insert content, specified by the parameter, to the end of each element in the set of matched elements.

    param func A function that returns an HTML string, DOM element(s), or jQuery object to insert at the end of each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, this refers to the current element in the set.

    Parameters

    • func: function
        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

appendTo

  • appendTo(target: JQuery | any[] | Element | string): JQuery
  • Insert every element in the set of matched elements to the end of the target.

    Parameters

    • target: JQuery | any[] | Element | string

      A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter.

    Returns JQuery

attr

  • attr(attributeName: string): string
  • attr(attributeName: string, value: string | number): JQuery
  • attr(attributeName: string, func: function): JQuery
  • attr(attributes: Object): JQuery
  • Get the value of an attribute for the first element in the set of matched elements.

    Parameters

    • attributeName: string

      The name of the attribute to get.

    Returns string

  • Set one or more attributes for the set of matched elements.

    Parameters

    • attributeName: string

      The name of the attribute to set.

    • value: string | number

      A value to set for the attribute.

    Returns JQuery

  • Set one or more attributes for the set of matched elements.

    Parameters

    • attributeName: string

      The name of the attribute to set.

    • func: function

      A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old attribute value as arguments.

        • (index: number, attr: string): string | number
        • Parameters

          • index: number
          • attr: string

          Returns string | number

    Returns JQuery

  • Set one or more attributes for the set of matched elements.

    Parameters

    • attributes: Object

      An object of attribute-value pairs to set.

    Returns JQuery

before

  • before(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • before(func: function): JQuery
  • Insert content, specified by the parameter, before each element in the set of matched elements.

    param content1 HTML string, DOM element, DocumentFragment, array of elements, or jQuery object to insert before each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert before each element in the set of matched elements.

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string
    • Rest ...content2: any[]

    Returns JQuery

  • Insert content, specified by the parameter, before each element in the set of matched elements.

    param func A function that returns an HTML string, DOM element(s), or jQuery object to insert before each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.

    Parameters

    • func: function
        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

bind

  • bind(eventType: string, eventData: any, handler: JQueryEventListener): JQuery
  • bind(eventType: string, handler: JQueryEventListener): JQuery
  • bind(eventType: string, eventData: any, preventBubble: boolean): JQuery
  • bind(eventType: string, preventBubble: boolean): JQuery
  • bind(events: any): JQuery
  • Attach a handler to an event for the elements.

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • eventData: any

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

  • Attach a handler to an event for the elements.

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

  • Attach a handler to an event for the elements.

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • eventData: any

      An object containing data that will be passed to the event handler.

    • preventBubble: 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.

    Returns JQuery

  • Attach a handler to an event for the elements.

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • preventBubble: 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.

    Returns JQuery

  • Attach a handler to an event for the elements.

    Parameters

    • events: any

      An object containing one or more DOM event types and functions to execute for them.

    Returns JQuery

blur

  • Trigger the "blur" event on an element

    Returns JQuery

  • Bind an event handler to the "blur" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "blur" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

change

  • Trigger the "change" event on an element.

    Returns JQuery

  • Bind an event handler to the "change" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "change" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

children

  • children(selector?: string): JQuery
  • Get the children of each element in the set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

clearQueue

  • clearQueue(queueName?: string): JQuery
  • Remove from the queue all items that have not yet been run.

    Parameters

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns JQuery

click

  • Trigger the "click" event on an element.

    Returns JQuery

  • Bind an event handler to the "click" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "click" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

clone

  • clone(withDataAndEvents?: boolean, deepWithDataAndEvents?: boolean): JQuery
  • Create a deep copy of the set of matched elements.

    param withDataAndEvents A Boolean indicating whether event handlers and data should be copied along with the elements. The default value is false. param deepWithDataAndEvents A Boolean indicating whether event handlers and data for all children of the cloned element should be copied. By default its value matches the first argument's value (which defaults to false).

    Parameters

    • Optional withDataAndEvents: boolean
    • Optional deepWithDataAndEvents: boolean

    Returns JQuery

closest

  • closest(selector: string): JQuery
  • closest(selector: string, context?: Element): JQuery
  • closest(obj: JQuery): JQuery
  • closest(element: Element): JQuery
  • closest(selectors: any, context?: Element): any[]
  • For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    • Optional context: Element

      A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead.

    Returns JQuery

  • For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

    Parameters

    • obj: JQuery

      A jQuery object to match elements against.

    Returns JQuery

  • For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

    Parameters

    • element: Element

      An element to match elements against.

    Returns JQuery

  • Get an array of all the elements and selectors matched against the current element up through the DOM tree.

    Parameters

    • selectors: any

      An array or string containing a selector expression to match elements against (can also be a jQuery object).

    • Optional context: Element

      A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead.

    Returns any[]

contents

  • contents(): JQuery
  • Get the children of each element in the set of matched elements, including text and comment nodes.

    Returns JQuery

contextmenu

  • contextmenu(): JQuery
  • contextmenu(handler: function): JQuery
  • contextmenu(eventData: Object, handler: function): JQuery
  • Trigger the "contextmenu" event on an element.

    Returns JQuery

  • Bind an event handler to the "contextmenu" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "contextmenu" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: function

      A function to execute when the event is triggered.

    Returns JQuery

controller

  • controller(name?: string): any
  • Parameters

    • Optional name: string

    Returns any

css

  • css(propertyName: string): string
  • css(propertyName: string, value: string | number): JQuery
  • css(propertyName: string, value: function): JQuery
  • css(properties: Object): JQuery
  • Get the value of style properties for the first element in the set of matched elements.

    Parameters

    • propertyName: string

      A CSS property.

    Returns string

  • Set one or more CSS properties for the set of matched elements.

    Parameters

    • propertyName: string

      A CSS property name.

    • value: string | number

      A value to set for the property.

    Returns JQuery

  • Set one or more CSS properties for the set of matched elements.

    Parameters

    • propertyName: string

      A CSS property name.

    • value: function

      A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old value as arguments.

        • (index: number, value: string): string | number
        • Parameters

          • index: number
          • value: string

          Returns string | number

    Returns JQuery

  • Set one or more CSS properties for the set of matched elements.

    Parameters

    • properties: Object

      An object of property-value pairs to set.

    Returns JQuery

data

  • data(key: string, value: any): JQuery
  • data(key: string): any
  • data(obj: object): JQuery
  • data(): any
  • Store arbitrary data associated with the matched elements.

    Parameters

    • key: string

      A string naming the piece of data to set.

    • value: any

      The new data value; it can be any Javascript type including Array or Object.

    Returns JQuery

  • Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.

    Parameters

    • key: string

      Name of the data stored.

    Returns any

  • Store arbitrary data associated with the matched elements.

    Parameters

    • obj: object

      An object of key-value pairs of data to update.

      • [key: string]: any

    Returns JQuery

  • Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.

    Returns any

dblclick

  • Trigger the "dblclick" event on an element.

    Returns JQuery

  • Bind an event handler to the "dblclick" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "dblclick" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

delay

  • delay(duration: number, queueName?: string): JQuery
  • Set a timer to delay execution of subsequent items in the queue.

    Parameters

    • duration: number

      An integer indicating the number of milliseconds to delay execution of the next item in the queue.

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns JQuery

delegate

  • Parameters

    Returns JQuery

  • Parameters

    Returns JQuery

dequeue

  • dequeue(queueName?: string): JQuery
  • Execute the next function on the queue for the matched elements.

    Parameters

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns JQuery

detach

  • detach(selector?: string): JQuery
  • Remove the set of matched elements from the DOM.

    param selector A selector expression that filters the set of matched elements to be removed.

    Parameters

    • Optional selector: string

    Returns JQuery

each

  • each(func: function): JQuery
  • Iterate over a jQuery object, executing a function for each matched element.

    Parameters

    • func: function

      A function to execute for each matched element.

        • (this: HTMLElement, index: number, elem: Element): any
        • Parameters

          • this: HTMLElement
          • index: number
          • elem: Element

          Returns any

    Returns JQuery

empty

  • empty(): JQuery
  • Remove all child nodes of the set of matched elements from the DOM.

    Returns JQuery

end

  • end(): JQuery
  • End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.

    Returns JQuery

eq

  • eq(index: number): JQuery
  • Reduce the set of matched elements to the one at the specified index.

    Parameters

    • index: number

      An integer indicating the 0-based position of the element. OR An integer indicating the position of the element, counting backwards from the last element in the set.

    Returns JQuery

error

  • error(handler: function): JQuery
  • error(eventData: any, handler: function): JQuery
  • Bind an event handler to the "error" JavaScript event. (DEPRECATED from v1.8)

    Parameters

    Returns JQuery

  • Bind an event handler to the "error" JavaScript event. (DEPRECATED from v1.8)

    Parameters

    • eventData: any

      A plain object of data that will be passed to the event handler.

    • handler: function

      A function to execute when the event is triggered.

    Returns JQuery

fadeIn

  • fadeIn(duration?: number | string, complete?: function): JQuery
  • fadeIn(duration?: number | string, easing?: string, complete?: function): JQuery
  • fadeIn(options: JQueryAnimationOptions): JQuery
  • Display the matched elements by fading them to opaque.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Display the matched elements by fading them to opaque.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Display the matched elements by fading them to opaque.

    Parameters

    Returns JQuery

fadeOut

  • fadeOut(duration?: number | string, complete?: function): JQuery
  • fadeOut(duration?: number | string, easing?: string, complete?: function): JQuery
  • fadeOut(options: JQueryAnimationOptions): JQuery
  • Hide the matched elements by fading them to transparent.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Hide the matched elements by fading them to transparent.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Hide the matched elements by fading them to transparent.

    Parameters

    Returns JQuery

fadeTo

  • fadeTo(duration: string | number, opacity: number, complete?: function): JQuery
  • fadeTo(duration: string | number, opacity: number, easing?: string, complete?: function): JQuery
  • Adjust the opacity of the matched elements.

    Parameters

    • duration: string | number

      A string or number determining how long the animation will run.

    • opacity: number

      A number between 0 and 1 denoting the target opacity.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Adjust the opacity of the matched elements.

    Parameters

    • duration: string | number

      A string or number determining how long the animation will run.

    • opacity: number

      A number between 0 and 1 denoting the target opacity.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

fadeToggle

  • fadeToggle(duration?: number | string, complete?: function): JQuery
  • fadeToggle(duration?: number | string, easing?: string, complete?: function): JQuery
  • fadeToggle(options: JQueryAnimationOptions): JQuery
  • Display or hide the matched elements by animating their opacity.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Display or hide the matched elements by animating their opacity.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: function

      A function to call once the animation is complete.

        • (this: HTMLElement): any
        • Parameters

          • this: HTMLElement

          Returns any

    Returns JQuery

  • Display or hide the matched elements by animating their opacity.

    Parameters

    Returns JQuery

filter

  • filter(selector: string): JQuery
  • filter(func: function): JQuery
  • filter(element: Element): JQuery
  • filter(obj: JQuery): JQuery
  • Reduce the set of matched elements to those that match the selector or pass the function's test.

    Parameters

    • selector: string

      A string containing a selector expression to match the current set of elements against.

    Returns JQuery

  • Reduce the set of matched elements to those that match the selector or pass the function's test.

    Parameters

    • func: function

      A function used as a test for each element in the set. this is the current DOM element.

        • (index: number, element: Element): any
        • Parameters

          • index: number
          • element: Element

          Returns any

    Returns JQuery

  • Reduce the set of matched elements to those that match the selector or pass the function's test.

    Parameters

    • element: Element

      An element to match the current set of elements against.

    Returns JQuery

  • Reduce the set of matched elements to those that match the selector or pass the function's test.

    Parameters

    • obj: JQuery

      An existing jQuery object to match the current set of elements against.

    Returns JQuery

find

  • find(selector: string): JQuery
  • find(element: Element): JQuery
  • find(obj: JQuery): JQuery
  • Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.

    Parameters

    • element: Element

      An element to match elements against.

    Returns JQuery

  • Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.

    Parameters

    • obj: JQuery

      A jQuery object to match elements against.

    Returns JQuery

finish

  • finish(queue?: string): JQuery
  • Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements.

    Parameters

    • Optional queue: string

      The name of the queue in which to stop animations.

    Returns JQuery

first

  • first(): JQuery
  • Reduce the set of matched elements to the first in the set.

    Returns JQuery

focus

  • Trigger the "focus" event on an element.

    Returns JQuery

  • Bind an event handler to the "focus" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "focus" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

focusin

  • Trigger the "focusin" event on an element.

    Returns JQuery

  • Bind an event handler to the "focusin" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "focusin" JavaScript event

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

focusout

  • Trigger the "focusout" event on an element.

    Returns JQuery

  • Bind an event handler to the "focusout" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "focusout" JavaScript event

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

get

  • get(index: number): HTMLElement
  • get(): any[]
  • Retrieve one of the elements matched by the jQuery object.

    Parameters

    • index: number

      A zero-based integer indicating which element to retrieve.

    Returns HTMLElement

  • Retrieve the elements matched by the jQuery object.

    Returns any[]

has

  • has(selector: string): JQuery
  • has(contained: Element): JQuery
  • Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.

    Parameters

    • contained: Element

      A DOM element to match elements against.

    Returns JQuery

hasClass

  • hasClass(className: string): boolean
  • Determine whether any of the matched elements are assigned the given class.

    Parameters

    • className: string

      The class name to search for.

    Returns boolean

height

  • height(): number
  • height(value: number | string): JQuery
  • height(func: function): JQuery
  • Get the current computed height for the first element in the set of matched elements.

    Returns number

  • Set the CSS height of every matched element.

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string).

    Returns JQuery

  • Set the CSS height of every matched element.

    Parameters

    • func: function

      A function returning the height to set. Receives the index position of the element in the set and the old height as arguments. Within the function, this refers to the current element in the set.

        • (index: number, height: number): number | string
        • Parameters

          • index: number
          • height: number

          Returns number | string

    Returns JQuery

hide

  • hide(duration?: number | string, complete?: Function): JQuery
  • hide(duration?: number | string, easing?: string, complete?: Function): JQuery
  • hide(options: JQueryAnimationOptions): JQuery
  • Hide the matched elements.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements.

    Parameters

    Returns JQuery

hover

  • Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.

    Parameters

    • handlerIn: JQueryEventListener

      A function to execute when the mouse pointer enters the element.

    • handlerOut: JQueryEventListener

      A function to execute when the mouse pointer leaves the element.

    Returns JQuery

  • Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements.

    Parameters

    • handlerInOut: JQueryEventListener

      A function to execute when the mouse pointer enters or leaves the element.

    Returns JQuery

html

  • html(): string
  • html(htmlString: string): JQuery
  • html(func: function): JQuery
  • Get the HTML contents of the first element in the set of matched elements.

    Returns string

  • Set the HTML contents of each element in the set of matched elements.

    Parameters

    • htmlString: string

      A string of HTML to set as the content of each matched element.

    Returns JQuery

  • Set the HTML contents of each element in the set of matched elements.

    Parameters

    • func: function

      A function returning the HTML content to set. Receives the index position of the element in the set and the old HTML value as arguments. jQuery empties the element before calling the function; use the oldhtml argument to reference the previous content. Within the function, this refers to the current element in the set.

        • (index: number, oldhtml: string): string
        • Parameters

          • index: number
          • oldhtml: string

          Returns string

    Returns JQuery

index

  • index(): number
  • index(selector: string | JQuery | Element): number
  • Search for a given element from among the matched elements.

    Returns number

  • Search for a given element from among the matched elements.

    Parameters

    • selector: string | JQuery | Element

      A selector representing a jQuery collection in which to look for an element.

    Returns number

inheritedData

  • inheritedData(key: string, value: any): JQuery
  • inheritedData(obj: object): JQuery
  • inheritedData(key?: string): any
  • Parameters

    • key: string
    • value: any

    Returns JQuery

  • Parameters

    • obj: object
      • [key: string]: any

    Returns JQuery

  • Parameters

    • Optional key: string

    Returns any

injector

  • injector(): ng.auto.IInjectorService
  • Returns ng.auto.IInjectorService

innerHeight

  • innerHeight(): number
  • innerHeight(height: number | string): JQuery
  • Get the current computed height for the first element in the set of matched elements, including padding but not border.

    Returns number

  • Sets the inner height on elements in the set of matched elements, including padding but not border.

    Parameters

    • height: number | string

    Returns JQuery

innerWidth

  • innerWidth(): number
  • innerWidth(width: number | string): JQuery
  • Get the current computed width for the first element in the set of matched elements, including padding but not border.

    Returns number

  • Sets the inner width on elements in the set of matched elements, including padding but not border.

    Parameters

    • width: number | string

    Returns JQuery

insertAfter

  • insertAfter(target: JQuery | any[] | Element | Text | string): JQuery
  • Insert every element in the set of matched elements after the target.

    param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter.

    Parameters

    • target: JQuery | any[] | Element | Text | string

    Returns JQuery

insertBefore

  • insertBefore(target: JQuery | any[] | Element | Text | string): JQuery
  • Insert every element in the set of matched elements before the target.

    param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter.

    Parameters

    • target: JQuery | any[] | Element | Text | string

    Returns JQuery

is

  • is(selector: string): boolean
  • is(func: function): boolean
  • is(obj: JQuery): boolean
  • is(elements: any): boolean
  • Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments.

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns boolean

  • Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments.

    Parameters

    • func: function

      A function used as a test for the set of elements. It accepts one argument, index, which is the element's index in the jQuery collection.Within the function, this refers to the current DOM element.

        • (index: number, element: Element): boolean
        • Parameters

          • index: number
          • element: Element

          Returns boolean

    Returns boolean

  • Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments.

    Parameters

    • obj: JQuery

      An existing jQuery object to match the current set of elements against.

    Returns boolean

  • Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments.

    Parameters

    • elements: any

      One or more elements to match the current set of elements against.

    Returns boolean

isolateScope

  • isolateScope<T>(): T
  • Type parameters

    • T: ng.IScope

    Returns T

keydown

  • Trigger the "keydown" event on an element.

    Returns JQuery

  • Bind an event handler to the "keydown" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "keydown" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryKeyEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

keypress

  • Trigger the "keypress" event on an element.

    Returns JQuery

  • Bind an event handler to the "keypress" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "keypress" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryKeyEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

keyup

  • Trigger the "keyup" event on an element.

    Returns JQuery

  • Bind an event handler to the "keyup" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "keyup" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryKeyEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

last

  • last(): JQuery
  • Reduce the set of matched elements to the final one in the set.

    Returns JQuery

load

  • Load data from the server and place the returned HTML into the matched element.

    Parameters

    • url: string

      A string containing the URL to which the request is sent.

    • Optional data: string | Object

      A plain object or string that is sent to the server with the request.

    • Optional complete: function

      A callback function that is executed when the request completes.

        • (responseText: string, textStatus: string, XMLHttpRequest: XMLHttpRequest): any
        • Parameters

          • responseText: string
          • textStatus: string
          • XMLHttpRequest: XMLHttpRequest

          Returns any

    Returns JQuery

  • Bind an event handler to the "load" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "load" JavaScript event.

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute when the event is triggered.

    Returns JQuery

map

  • map(callback: function): JQuery
  • Pass each element in the current matched set through a function, producing a new jQuery object containing the return values.

    Parameters

    • callback: function

      A function object that will be invoked for each element in the current set.

        • (index: number, domElement: Element): any
        • Parameters

          • index: number
          • domElement: Element

          Returns any

    Returns JQuery

mousedown

  • Trigger the "mousedown" event on an element.

    Returns JQuery

  • Bind an event handler to the "mousedown" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "mousedown" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

mouseenter

  • Trigger the "mouseenter" event on an element.

    Returns JQuery

  • Bind an event handler to be fired when the mouse enters an element.

    Parameters

    Returns JQuery

  • Bind an event handler to be fired when the mouse enters an element.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

mouseleave

  • Trigger the "mouseleave" event on an element.

    Returns JQuery

  • Bind an event handler to be fired when the mouse leaves an element.

    Parameters

    Returns JQuery

  • Bind an event handler to be fired when the mouse leaves an element.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

mousemove

  • Trigger the "mousemove" event on an element.

    Returns JQuery

  • Bind an event handler to the "mousemove" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "mousemove" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

mouseout

  • Trigger the "mouseout" event on an element.

    Returns JQuery

  • Bind an event handler to the "mouseout" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "mouseout" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

mouseover

  • Trigger the "mouseover" event on an element.

    Returns JQuery

  • Bind an event handler to the "mouseover" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "mouseover" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

mouseup

  • Trigger the "mouseup" event on an element.

    Returns JQuery

  • Bind an event handler to the "mouseup" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "mouseup" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryMouseEventListener

      A function to execute when the event is triggered.

    Returns JQuery

next

  • next(selector?: string): JQuery
  • Get the immediately following sibling of each element in the set of matched elements. If a selector is provided, it retrieves the next sibling only if it matches that selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

nextAll

  • nextAll(selector?: string): JQuery
  • Get all following siblings of each element in the set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

nextUntil

  • nextUntil(selector?: string, filter?: string): JQuery
  • nextUntil(element?: Element, filter?: string): JQuery
  • nextUntil(obj?: JQuery, filter?: string): JQuery
  • Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.

    Parameters

    • Optional selector: string

      A string containing a selector expression to indicate where to stop matching following sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.

    Parameters

    • Optional element: Element

      A DOM node or jQuery object indicating where to stop matching following sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.

    Parameters

    • Optional obj: JQuery

      A DOM node or jQuery object indicating where to stop matching following sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

not

  • not(selector: string): JQuery
  • not(func: function): JQuery
  • not(elements: Element | Element[]): JQuery
  • not(obj: JQuery): JQuery
  • Remove elements from the set of matched elements.

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Remove elements from the set of matched elements.

    Parameters

    • func: function

      A function used as a test for each element in the set. this is the current DOM element.

        • (index: number, element: Element): boolean
        • Parameters

          • index: number
          • element: Element

          Returns boolean

    Returns JQuery

  • Remove elements from the set of matched elements.

    Parameters

    • elements: Element | Element[]

      One or more DOM elements to remove from the matched set.

    Returns JQuery

  • Remove elements from the set of matched elements.

    Parameters

    • obj: JQuery

      An existing jQuery object to match the current set of elements against.

    Returns JQuery

off

  • Remove an event handler.

    Returns JQuery

  • Remove an event handler.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".

    • Optional selector: string

      A selector which should match the one originally passed to .on() when attaching event handlers.

    • Optional handler: JQueryEventListener

      A handler function previously attached for the event(s), or the special value false.

    Returns JQuery

  • Remove an event handler.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".

    • handler: JQueryEventListener

      A handler function previously attached for the event(s), or the special value false. Takes handler with extra args that can be attached with on().

    Returns JQuery

  • Remove an event handler.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".

    • handler: JQueryEventListener

      A handler function previously attached for the event(s), or the special value false.

    Returns JQuery

  • Remove an event handler.

    Parameters

    • events: object

      An object where the string keys represent one or more space-separated event types and optional namespaces, and the values represent handler functions previously attached for the event(s).

      • [key: string]: any
    • Optional selector: string

      A selector which should match the one originally passed to .on() when attaching event handlers.

    Returns JQuery

offset

  • Get the current coordinates of the first element in the set of matched elements, relative to the document.

    Returns JQueryCoordinates

  • An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.

    Parameters

    • coordinates: JQueryCoordinates

      An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.

    Returns JQuery

  • An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.

    Parameters

    • func: function

      A function to return the coordinates to set. Receives the index of the element in the collection as the first argument and the current coordinates as the second argument. The function should return an object with the new top and left properties.

    Returns JQuery

offsetParent

  • offsetParent(): JQuery
  • Get the closest ancestor element that is positioned.

    Returns JQuery

on

  • on(events: string, handler: JQueryEventListener): JQuery
  • on(events: string, data: any, handler: JQueryEventListener): JQuery
  • on(events: string, selector: string, handler: JQueryEventListener): JQuery
  • on(events: string, selector: string, data: any, handler: JQueryEventListener): JQuery
  • on(events: object, selector?: string, data?: any): JQuery
  • on(events: object, data?: any): JQuery
  • Attach an event handler function for one or more events to the selected elements.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • handler: JQueryEventListener

      A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false. Rest parameter args is for optional parameters passed to jQuery.trigger(). Note that the actual parameters on the event handler function must be marked as optional (? syntax).

    Returns JQuery

  • Attach an event handler function for one or more events to the selected elements.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • data: any

      Data to be passed to the handler in event.data when an event is triggered.

    • handler: JQueryEventListener

      A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.

    Returns JQuery

  • Attach an event handler function for one or more events to the selected elements.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.

    • handler: JQueryEventListener

      A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.

    Returns JQuery

  • Attach an event handler function for one or more events to the selected elements.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.

    • data: any

      Data to be passed to the handler in event.data when an event is triggered.

    • handler: JQueryEventListener

      A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.

    Returns JQuery

  • Attach an event handler function for one or more events to the selected elements.

    Parameters

    • events: object

      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).

      • [key: string]: any
    • Optional selector: string

      A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.

    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

  • Attach an event handler function for one or more events to the selected elements.

    Parameters

    • events: object

      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).

      • [key: string]: any
    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

one

  • one(events: string, handler: JQueryEventListener): JQuery
  • one(events: string, data: Object, handler: JQueryEventListener): JQuery
  • one(events: string, selector: string, handler: JQueryEventListener): JQuery
  • one(events: string, selector: string, data: any, handler: JQueryEventListener): JQuery
  • one(events: object, selector?: string, data?: any): JQuery
  • one(events: object, data?: any): JQuery
  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    Parameters

    • events: string

      A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.

    • handler: JQueryEventListener

      A function to execute at the time the event is triggered.

    Returns JQuery

  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    Parameters

    • events: string

      A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.

    • data: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute at the time the event is triggered.

    Returns JQuery

  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.

    • handler: JQueryEventListener

      A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.

    Returns JQuery

  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.

    • data: any

      Data to be passed to the handler in event.data when an event is triggered.

    • handler: JQueryEventListener

      A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.

    Returns JQuery

  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    Parameters

    • events: object

      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).

      • [key: string]: any
    • Optional selector: string

      A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.

    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    Parameters

    • events: object

      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).

      • [key: string]: any
    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

outerHeight

  • outerHeight(includeMargin?: boolean): number
  • outerHeight(height: number | string): JQuery
  • Get the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. Returns an integer (without "px") representation of the value or null if called on an empty set of elements.

    Parameters

    • Optional includeMargin: boolean

      A Boolean indicating whether to include the element's margin in the calculation.

    Returns number

  • Sets the outer height on elements in the set of matched elements, including padding and border.

    Parameters

    • height: number | string

    Returns JQuery

outerWidth

  • outerWidth(includeMargin?: boolean): number
  • outerWidth(width: number | string): JQuery
  • Get the current computed width for the first element in the set of matched elements, including padding and border.

    Parameters

    • Optional includeMargin: boolean

      A Boolean indicating whether to include the element's margin in the calculation.

    Returns number

  • Sets the outer width on elements in the set of matched elements, including padding and border.

    Parameters

    • width: number | string

    Returns JQuery

parent

  • parent(selector?: string): JQuery
  • Get the parent of each element in the current set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

parents

  • parents(selector?: string): JQuery
  • Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

parentsUntil

  • parentsUntil(selector?: string, filter?: string): JQuery
  • parentsUntil(element?: Element, filter?: string): JQuery
  • parentsUntil(obj?: JQuery, filter?: string): JQuery
  • Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or jQuery object.

    Parameters

    • Optional selector: string

      A string containing a selector expression to indicate where to stop matching ancestor elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or jQuery object.

    Parameters

    • Optional element: Element

      A DOM node or jQuery object indicating where to stop matching ancestor elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or jQuery object.

    Parameters

    • Optional obj: JQuery

      A DOM node or jQuery object indicating where to stop matching ancestor elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

position

  • Get the current coordinates of the first element in the set of matched elements, relative to the offset parent.

    Returns JQueryCoordinates

prepend

  • prepend(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • prepend(func: function): JQuery
  • Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.

    param content1 DOM element, DocumentFragment, array of elements, HTML string, or jQuery object to insert at the beginning of each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert at the beginning of each element in the set of matched elements.

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string
    • Rest ...content2: any[]

    Returns JQuery

  • Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.

    param func A function that returns an HTML string, DOM element(s), or jQuery object to insert at the beginning of each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, this refers to the current element in the set.

    Parameters

    • func: function
        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

prependTo

  • prependTo(target: JQuery | any[] | Element | string): JQuery
  • Insert every element in the set of matched elements to the beginning of the target.

    Parameters

    • target: JQuery | any[] | Element | string

      A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter.

    Returns JQuery

prev

  • prev(selector?: string): JQuery
  • Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

prevAll

  • prevAll(selector?: string): JQuery
  • Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

prevUntil

  • prevUntil(selector?: string, filter?: string): JQuery
  • prevUntil(element?: Element, filter?: string): JQuery
  • prevUntil(obj?: JQuery, filter?: string): JQuery
  • Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.

    Parameters

    • Optional selector: string

      A string containing a selector expression to indicate where to stop matching preceding sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.

    Parameters

    • Optional element: Element

      A DOM node or jQuery object indicating where to stop matching preceding sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.

    Parameters

    • Optional obj: JQuery

      A DOM node or jQuery object indicating where to stop matching preceding sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

promise

  • Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.

    Parameters

    • Optional type: string

      The type of queue that needs to be observed. (default: fx)

    • Optional target: Object

      Object onto which the promise methods have to be attached

    Returns JQueryPromise<any>

prop

  • prop(propertyName: string): any
  • prop(propertyName: string, value: string | number | boolean): JQuery
  • prop(properties: Object): JQuery
  • prop(propertyName: string, func: function): JQuery
  • Get the value of a property for the first element in the set of matched elements.

    Parameters

    • propertyName: string

      The name of the property to get.

    Returns any

  • Set one or more properties for the set of matched elements.

    Parameters

    • propertyName: string

      The name of the property to set.

    • value: string | number | boolean

      A value to set for the property.

    Returns JQuery

  • Set one or more properties for the set of matched elements.

    Parameters

    • properties: Object

      An object of property-value pairs to set.

    Returns JQuery

  • Set one or more properties for the set of matched elements.

    Parameters

    • propertyName: string

      The name of the property to set.

    • func: function

      A function returning the value to set. Receives the index position of the element in the set and the old property value as arguments. Within the function, the keyword this refers to the current element.

        • (index: number, oldPropertyValue: any): any
        • Parameters

          • index: number
          • oldPropertyValue: any

          Returns any

    Returns JQuery

pushStack

  • pushStack(elements: any[]): JQuery
  • pushStack(elements: any[], name: string, arguments: any[]): JQuery
  • Add a collection of DOM elements onto the jQuery stack.

    Parameters

    • elements: any[]

      An array of elements to push onto the stack and make into a new jQuery object.

    Returns JQuery

  • Add a collection of DOM elements onto the jQuery stack.

    Parameters

    • elements: any[]

      An array of elements to push onto the stack and make into a new jQuery object.

    • name: string

      The name of a jQuery method that generated the array of elements.

    • arguments: any[]

      The arguments that were passed in to the jQuery method (for serialization).

    Returns JQuery

queue

  • queue(queueName?: string): any[]
  • queue(newQueue: Function[]): JQuery
  • queue(callback: Function): JQuery
  • queue(queueName: string, newQueue: Function[]): JQuery
  • queue(queueName: string, callback: Function): JQuery
  • Show the queue of functions to be executed on the matched elements.

    Parameters

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns any[]

  • Manipulate the queue of functions to be executed, once for each matched element.

    Parameters

    • newQueue: Function[]

      An array of functions to replace the current queue contents.

    Returns JQuery

  • Manipulate the queue of functions to be executed, once for each matched element.

    Parameters

    • callback: Function

      The new function to add to the queue, with a function to call that will dequeue the next item.

    Returns JQuery

  • Manipulate the queue of functions to be executed, once for each matched element.

    Parameters

    • queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    • newQueue: Function[]

      An array of functions to replace the current queue contents.

    Returns JQuery

  • Manipulate the queue of functions to be executed, once for each matched element.

    Parameters

    • queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    • callback: Function

      The new function to add to the queue, with a function to call that will dequeue the next item.

    Returns JQuery

ready

  • ready(handler: function): JQuery
  • Specify a function to execute when the DOM is fully loaded.

    Parameters

    • handler: function

      A function to execute after the DOM is ready.

    Returns JQuery

remove

  • remove(selector?: string): JQuery
  • Remove the set of matched elements from the DOM.

    Parameters

    • Optional selector: string

      A selector expression that filters the set of matched elements to be removed.

    Returns JQuery

removeAttr

  • removeAttr(attributeName: string): JQuery
  • Remove an attribute from each element in the set of matched elements.

    Parameters

    • attributeName: string

      An attribute to remove; as of version 1.7, it can be a space-separated list of attributes.

    Returns JQuery

removeClass

  • removeClass(className?: string): JQuery
  • removeClass(func: function): JQuery
  • Remove a single class, multiple classes, or all classes from each element in the set of matched elements.

    Parameters

    • Optional className: string

      One or more space-separated classes to be removed from the class attribute of each matched element.

    Returns JQuery

  • Remove a single class, multiple classes, or all classes from each element in the set of matched elements.

    Parameters

    • func: function
        • (index: number, className: string): string
        • Parameters

          • index: number
          • className: string

          Returns string

    Returns JQuery

removeData

  • removeData(name: string): JQuery
  • removeData(list: string[]): JQuery
  • removeData(): JQuery
  • Remove a previously-stored piece of data.

    Parameters

    • name: string

      A string naming the piece of data to delete or space-separated string naming the pieces of data to delete.

    Returns JQuery

  • Remove a previously-stored piece of data.

    Parameters

    • list: string[]

      An array of strings naming the pieces of data to delete.

    Returns JQuery

  • Remove all previously-stored piece of data.

    Returns JQuery

removeProp

  • removeProp(propertyName: string): JQuery
  • Remove a property for the set of matched elements.

    Parameters

    • propertyName: string

      The name of the property to remove.

    Returns JQuery

replaceAll

  • replaceAll(target: JQuery | any[] | Element | string): JQuery
  • Replace each target element with the set of matched elements.

    Parameters

    • target: JQuery | any[] | Element | string

      A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace.

    Returns JQuery

replaceWith

  • replaceWith(newContent: JQuery | any[] | Element | Text | string): JQuery
  • replaceWith(func: function): JQuery
  • Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.

    param newContent The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object.

    Parameters

    • newContent: JQuery | any[] | Element | Text | string

    Returns JQuery

  • Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.

    param func A function that returns content with which to replace the set of matched elements.

    Parameters

    • func: function
        • (): Element | JQuery
        • Returns Element | JQuery

    Returns JQuery

resize

  • Trigger the "resize" event on an element.

    Returns JQuery

  • Bind an event handler to the "resize" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "resize" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

scope

  • scope<T>(): T
  • It's declared generic for custom scope interfaces

    Type parameters

    • T: ng.IScope

    Returns T

scroll

  • Trigger the "scroll" event on an element.

    Returns JQuery

  • Bind an event handler to the "scroll" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "scroll" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

scrollLeft

  • scrollLeft(): number
  • scrollLeft(value: number): JQuery
  • Get the current horizontal position of the scroll bar for the first element in the set of matched elements or set the horizontal position of the scroll bar for every matched element.

    Returns number

  • Set the current horizontal position of the scroll bar for each of the set of matched elements.

    Parameters

    • value: number

      An integer indicating the new position to set the scroll bar to.

    Returns JQuery

scrollTop

  • scrollTop(): number
  • scrollTop(value: number): JQuery
  • Get the current vertical position of the scroll bar for the first element in the set of matched elements or set the vertical position of the scroll bar for every matched element.

    Returns number

  • Set the current vertical position of the scroll bar for each of the set of matched elements.

    Parameters

    • value: number

      An integer indicating the new position to set the scroll bar to.

    Returns JQuery

select

  • Trigger the "select" event on an element.

    Returns JQuery

  • Bind an event handler to the "select" JavaScript event.

    Parameters

    Returns JQuery

  • Bind an event handler to the "select" JavaScript event.

    Parameters

    • eventData: Object

      An object containing data that will be passed to the event handler.

    • handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

serialize

  • serialize(): string
  • Encode a set of form elements as a string for submission.

    Returns string

serializeArray

show

  • show(duration?: number | string, complete?: Function): JQuery
  • show(duration?: number | string, easing?: string, complete?: Function): JQuery
  • show(options: JQueryAnimationOptions): JQuery
  • Display the matched elements.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements.

    Parameters

    Returns JQuery

siblings

  • siblings(selector?: string): JQuery
  • Get the siblings of each element in the set of matched elements, optionally filtered by a selector.

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

slice

  • slice(start: number, end?: number): JQuery
  • Reduce the set of matched elements to a subset specified by a range of indices.

    Parameters

    • start: number

      An integer indicating the 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set.

    • Optional end: number

      An integer indicating the 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set. If omitted, the range continues until the end of the set.

    Returns JQuery

slideDown

  • slideDown(duration?: number | string, complete?: Function): JQuery
  • slideDown(duration?: number | string, easing?: string, complete?: Function): JQuery
  • slideDown(options: JQueryAnimationOptions): JQuery
  • Display the matched elements with a sliding motion.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements with a sliding motion.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements with a sliding motion.

    Parameters

    Returns JQuery

slideToggle

  • slideToggle(duration?: number | string, complete?: Function): JQuery
  • slideToggle(duration?: number | string, easing?: string, complete?: Function): JQuery
  • slideToggle(options: JQueryAnimationOptions): JQuery
  • Display or hide the matched elements with a sliding motion.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements with a sliding motion.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements with a sliding motion.

    Parameters

    Returns JQuery

slideUp

  • slideUp(duration?: number | string, complete?: Function): JQuery
  • slideUp(duration?: number | string, easing?: string, complete?: Function): JQuery
  • slideUp(options: JQueryAnimationOptions): JQuery
  • Hide the matched elements with a sliding motion.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements with a sliding motion.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements with a sliding motion.

    Parameters

    Returns JQuery

stop

  • stop(clearQueue?: boolean, jumpToEnd?: boolean): JQuery
  • stop(queue?: string, clearQueue?: boolean, jumpToEnd?: boolean): JQuery
  • Stop the currently-running animation on the matched elements.

    Parameters

    • Optional clearQueue: boolean

      A Boolean indicating whether to remove queued animation as well. Defaults to false.

    • Optional jumpToEnd: boolean

      A Boolean indicating whether to complete the current animation immediately. Defaults to false.

    Returns JQuery

  • Stop the currently-running animation on the matched elements.

    Parameters

    • Optional queue: string

      The name of the queue in which to stop animations.

    • Optional clearQueue: boolean

      A Boolean indicating whether to remove queued animation as well. Defaults to false.

    • Optional jumpToEnd: boolean

      A Boolean indicating whether to complete the current animation immediately. Defaults to false.

    Returns JQuery

submit

  • Trigger the "submit" event on an element.

    Returns JQuery

  • Bind an event handler to the "submit" JavaScript event

    Parameters

    Returns JQuery

  • Bind an event handler to the "submit" JavaScript event

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute each time the event is triggered.

    Returns JQuery

text

  • text(): string
  • text(text: string | number | boolean): JQuery
  • text(func: function): JQuery
  • Get the combined text contents of each element in the set of matched elements, including their descendants.

    Returns string

  • Set the content of each element in the set of matched elements to the specified text.

    Parameters

    • text: string | number | boolean

      The text to set as the content of each matched element. When Number or Boolean is supplied, it will be converted to a String representation.

    Returns JQuery

  • Set the content of each element in the set of matched elements to the specified text.

    Parameters

    • func: function

      A function returning the text content to set. Receives the index position of the element in the set and the old text value as arguments.

        • (index: number, text: string): string
        • Parameters

          • index: number
          • text: string

          Returns string

    Returns JQuery

toArray

  • toArray(): any[]
  • Retrieve all the elements contained in the jQuery set, as an array.

    Returns any[]

toggle

  • toggle(duration?: number | string, complete?: Function): JQuery
  • toggle(duration?: number | string, easing?: string, complete?: Function): JQuery
  • toggle(options: JQueryAnimationOptions): JQuery
  • toggle(showOrHide: boolean): JQuery
  • Display or hide the matched elements.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements.

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements.

    Parameters

    Returns JQuery

  • Display or hide the matched elements.

    Parameters

    • showOrHide: boolean

      A Boolean indicating whether to show or hide the elements.

    Returns JQuery

toggleClass

  • toggleClass(className: string, swtch?: boolean): JQuery
  • toggleClass(swtch?: boolean): JQuery
  • toggleClass(func: function, swtch?: boolean): JQuery
  • Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the switch argument.

    Parameters

    • className: string

      One or more class names (separated by spaces) to be toggled for each element in the matched set.

    • Optional swtch: boolean

      A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed.

    Returns JQuery

  • Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the switch argument.

    Parameters

    • Optional swtch: boolean

      A boolean value to determine whether the class should be added or removed.

    Returns JQuery

  • Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the switch argument.

    Parameters

    • func: function

      A function that returns class names to be toggled in the class attribute of each element in the matched set. Receives the index position of the element in the set, the old class value, and the switch as arguments.

        • (index: number, className: string, swtch: boolean): string
        • Parameters

          • index: number
          • className: string
          • swtch: boolean

          Returns string

    • Optional swtch: boolean

      A boolean value to determine whether the class should be added or removed.

    Returns JQuery

trigger

  • trigger(eventType: string, extraParameters?: any[] | Object): JQuery
  • trigger(event: JQueryEventObject, extraParameters?: any[] | Object): JQuery
  • Execute all handlers and behaviors attached to the matched elements for the given event type.

    Parameters

    • eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • Optional extraParameters: any[] | Object

      Additional parameters to pass along to the event handler.

    Returns JQuery

  • Execute all handlers and behaviors attached to the matched elements for the given event type.

    Parameters

    • event: JQueryEventObject

      A jQuery.Event object.

    • Optional extraParameters: any[] | Object

      Additional parameters to pass along to the event handler.

    Returns JQuery

triggerHandler

  • triggerHandler(eventType: string, ...extraParameters: any[]): Object
  • triggerHandler(event: JQueryEventObject, ...extraParameters: any[]): Object
  • Execute all handlers attached to an element for an event.

    Parameters

    • eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • Rest ...extraParameters: any[]

      An array of additional parameters to pass along to the event handler.

    Returns Object

  • Execute all handlers attached to an element for an event.

    Parameters

    • event: JQueryEventObject

      A jQuery.Event object.

    • Rest ...extraParameters: any[]

      An array of additional parameters to pass along to the event handler.

    Returns Object

unbind

  • unbind(eventType?: string, handler?: JQueryEventListener): JQuery
  • unbind(eventType: string, fls: boolean): JQuery
  • unbind(evt: any): JQuery
  • Remove a previously-attached event handler from the elements.

    Parameters

    • Optional eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • Optional handler: JQueryEventListener

      The function that is to be no longer executed.

    Returns JQuery

  • Remove a previously-attached event handler from the elements.

    Parameters

    • eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • fls: boolean

      Unbinds the corresponding 'return false' function that was bound using .bind( eventType, false ).

    Returns JQuery

  • Remove a previously-attached event handler from the elements.

    Parameters

    • evt: any

      A JavaScript event object as passed to an event handler.

    Returns JQuery

undelegate

  • undelegate(): JQuery
  • undelegate(selector: string, eventType: string, handler?: JQueryEventListener): JQuery
  • undelegate(selector: string, events: Object): JQuery
  • undelegate(namespace: string): JQuery
  • Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.

    Returns JQuery

  • Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.

    Parameters

    • selector: string

      A selector which will be used to filter the event results.

    • eventType: string

      A string containing a JavaScript event type, such as "click" or "keydown"

    • Optional handler: JQueryEventListener

      A function to execute at the time the event is triggered.

    Returns JQuery

  • Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.

    Parameters

    • selector: string

      A selector which will be used to filter the event results.

    • events: Object

      An object of one or more event types and previously bound functions to unbind from them.

    Returns JQuery

  • Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.

    Parameters

    • namespace: string

      A string containing a namespace to unbind all events from.

    Returns JQuery

unload

  • Bind an event handler to the "unload" JavaScript event. (DEPRECATED from v1.8)

    Parameters

    Returns JQuery

  • Bind an event handler to the "unload" JavaScript event. (DEPRECATED from v1.8)

    Parameters

    • Optional eventData: any

      A plain object of data that will be passed to the event handler.

    • Optional handler: JQueryEventListener

      A function to execute when the event is triggered.

    Returns JQuery

unwrap

  • unwrap(): JQuery
  • Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place.

    Returns JQuery

val

  • val(): any
  • val(value: string | string[] | number): JQuery
  • val(func: function): JQuery
  • Get the current value of the first element in the set of matched elements.

    Returns any

  • Set the value of each element in the set of matched elements.

    Parameters

    • value: string | string[] | number

      A string of text, an array of strings or number corresponding to the value of each matched element to set as selected/checked.

    Returns JQuery

  • Set the value of each element in the set of matched elements.

    Parameters

    • func: function

      A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old value as arguments.

        • (index: number, value: string): string
        • Parameters

          • index: number
          • value: string

          Returns string

    Returns JQuery

width

  • width(): number
  • width(value: number | string): JQuery
  • width(func: function): JQuery
  • Get the current computed width for the first element in the set of matched elements.

    Returns number

  • Set the CSS width of each element in the set of matched elements.

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).

    Returns JQuery

  • Set the CSS width of each element in the set of matched elements.

    Parameters

    • func: function

      A function returning the width to set. Receives the index position of the element in the set and the old width as arguments. Within the function, this refers to the current element in the set.

        • (index: number, width: number): number | string
        • Parameters

          • index: number
          • width: number

          Returns number | string

    Returns JQuery

wrap

  • wrap(wrappingElement: JQuery | Element | string): JQuery
  • wrap(func: function): JQuery
  • Wrap an HTML structure around each element in the set of matched elements.

    Parameters

    • wrappingElement: JQuery | Element | string

      A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.

    Returns JQuery

  • Wrap an HTML structure around each element in the set of matched elements.

    Parameters

    • func: function

      A callback function returning the HTML content or jQuery object to wrap around the matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.

        • (index: number): string | JQuery
        • Parameters

          • index: number

          Returns string | JQuery

    Returns JQuery

wrapAll

  • wrapAll(wrappingElement: JQuery | Element | string): JQuery
  • wrapAll(func: function): JQuery
  • Wrap an HTML structure around all elements in the set of matched elements.

    Parameters

    • wrappingElement: JQuery | Element | string

      A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.

    Returns JQuery

  • Parameters

    • func: function
        • (index: number): string
        • Parameters

          • index: number

          Returns string

    Returns JQuery

wrapInner

  • wrapInner(wrappingElement: JQuery | Element | string): JQuery
  • wrapInner(func: function): JQuery
  • Wrap an HTML structure around the content of each element in the set of matched elements.

    Parameters

    • wrappingElement: JQuery | Element | string

      An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements.

    Returns JQuery

  • Wrap an HTML structure around the content of each element in the set of matched elements.

    Parameters

    • func: function

      A callback function which generates a structure to wrap around the content of the matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.

        • (index: number): string
        • Parameters

          • index: number

          Returns string

    Returns JQuery

Generated using TypeDoc