Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAugmentedJQueryStatic

These interfaces are kept for compatibility with older versions of these type definitions. Actually, Angular doesn't create a special subclass of jQuery objects. It extends jQuery.prototype like jQuery plugins do, that's why all jQuery objects have these Angular-specific methods, not only those returned from angular.element. See: http://docs.angularjs.org/api/angular.element

Hierarchy

Callable

  • __call(selector: string, context?: Element | JQuery): JQuery
  • __call(element: Element): JQuery
  • __call(elementArray: Element[]): JQuery
  • __call(callback: function): JQuery
  • __call(object: object): JQuery
  • __call(object: JQuery): JQuery
  • __call(): JQuery
  • __call(html: string, ownerDocument?: Document): JQuery
  • __call(html: string, attributes: Object): JQuery
  • Accepts a string containing a CSS selector which is then used to match a set of elements.

    Parameters

    • selector: string

      A string containing a selector expression

    • Optional context: Element | JQuery

      A DOM Element, Document, or jQuery to use as context

    Returns JQuery

  • Accepts a string containing a CSS selector which is then used to match a set of elements.

    Parameters

    • element: Element

      A DOM element to wrap in a jQuery object.

    Returns JQuery

  • Accepts a string containing a CSS selector which is then used to match a set of elements.

    Parameters

    • elementArray: Element[]

      An array containing a set of DOM elements to wrap in a jQuery object.

    Returns JQuery

  • Binds a function to be executed when the DOM has finished loading.

    Parameters

    • callback: function

      A function to execute after the DOM is ready.

    Returns JQuery

  • Accepts a string containing a CSS selector which is then used to match a set of elements.

    Parameters

    • object: object

      A plain object to wrap in a jQuery object.

    Returns JQuery

  • Accepts a string containing a CSS selector which is then used to match a set of elements.

    Parameters

    • object: JQuery

      An existing jQuery object to clone.

    Returns JQuery

  • Specify a function to execute when the DOM is fully loaded.

    Returns JQuery

  • Creates DOM elements on the fly from the provided string of raw HTML.

    Parameters

    • html: string

      A string of HTML to create on the fly. Note that this parses HTML, not XML.

    • Optional ownerDocument: Document

      A document in which the new elements will be created.

    Returns JQuery

  • Creates DOM elements on the fly from the provided string of raw HTML.

    Parameters

    • html: string

      A string defining a single, standalone, HTML element (e.g.

      or
      ).

    • attributes: Object

      An object of attributes, events, and methods to call on the newly-created element.

    Returns JQuery

Index

Properties

Event

ajaxSettings

ajaxSettings: JQueryAjaxSettings

cssHooks

cssHooks: object

Hook directly into jQuery to override how particular CSS properties are retrieved or set, normalize CSS property naming, or create custom properties.

Type declaration

  • [key: string]: any

cssNumber

cssNumber: any

easing

Effects

expr

expr: any

fn

fn: any

fx

fx: object

Type declaration

  • interval: number

    The rate (in milliseconds) at which animations fire.

  • off: boolean

    Globally disable all animations.

  • speeds: object
    • fast: number
    • slow: number
  • step: any
  • stop: function
      • (): void
      • Returns void

  • tick: function
      • (): void
      • Returns void

isReady

isReady: boolean

param

Create a serialized representation of an array or object, suitable for use in a URL query string or Ajax request.

support

support: JQuerySupport

Methods

Callbacks

  • A multi-purpose callbacks list object that provides a powerful way to manage callback lists.

    Parameters

    • Optional flags: string

      An optional list of space-separated flags that change how the callback list behaves.

    Returns JQueryCallback

Deferred

  • A constructor function that returns a chainable utility object with methods to register multiple callbacks into callback queues, invoke callback queues, and relay the success or failure state of any synchronous or asynchronous function.

    Type parameters

    • T

    Parameters

    • Optional beforeStart: function

      A function that is called just before the constructor returns.

    Returns JQueryDeferred<T>

ajax

  • Perform an asynchronous HTTP (Ajax) request.

    Parameters

    • settings: JQueryAjaxSettings

      A set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup().

    Returns JQueryXHR

  • Perform an asynchronous HTTP (Ajax) request.

    Parameters

    • url: string

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

    • Optional settings: JQueryAjaxSettings

      A set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup().

    Returns JQueryXHR

ajaxPrefilter

  • ajaxPrefilter(dataTypes: string, handler: function): void
  • ajaxPrefilter(handler: function): void
  • Handle custom Ajax options or modify existing options before each request is sent and before they are processed by $.ajax().

    Parameters

    • dataTypes: string

      An optional string containing one or more space-separated dataTypes

    • handler: function

      A handler to set default values for future Ajax requests.

    Returns void

  • Handle custom Ajax options or modify existing options before each request is sent and before they are processed by $.ajax().

    Parameters

    Returns void

ajaxSetup

  • Set default values for future Ajax requests. Its use is not recommended.

    Parameters

    • options: JQueryAjaxSettings

      A set of key/value pairs that configure the default Ajax request. All options are optional.

    Returns void

contains

  • contains(container: Element, contained: Element): boolean
  • Check to see if a DOM element is a descendant of another DOM element.

    Parameters

    • container: Element

      The DOM element that may contain the other element.

    • contained: Element

      The DOM element that may be contained by (a descendant of) the other element.

    Returns boolean

data

  • data<T>(element: Element, key: string, value: T): T
  • data(element: Element, key: string): any
  • data(element: Element): any
  • Store arbitrary data associated with the specified element. Returns the value that was set.

    Type parameters

    • T

    Parameters

    • element: Element

      The DOM element to associate with the data.

    • key: string

      A string naming the piece of data to set.

    • value: T

      The new data value.

    Returns T

  • Returns value at named data store for the element, as set by jQuery.data(element, name, value), or the full data store for the element.

    Parameters

    • element: Element

      The DOM element to associate with the data.

    • key: string

      A string naming the piece of data to set.

    Returns any

  • Returns value at named data store for the element, as set by jQuery.data(element, name, value), or the full data store for the element.

    Parameters

    • element: Element

      The DOM element to associate with the data.

    Returns any

dequeue

  • dequeue(element: Element, queueName?: string): void
  • Execute the next function on the queue for the matched element.

    Parameters

    • element: Element

      A DOM element from which to remove and execute a queued function.

    • Optional queueName: string

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

    Returns void

each

  • each<T>(collection: T[], callback: function): any
  • each(collection: any, callback: function): any
  • A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties.

    Type parameters

    • T

    Parameters

    • collection: T[]

      The object or array to iterate over.

    • callback: function

      The function that will be executed on every object.

        • (this: T, indexInArray: number, valueOfElement: T): any
        • Parameters

          • this: T
          • indexInArray: number
          • valueOfElement: T

          Returns any

    Returns any

  • A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties.

    Parameters

    • collection: any

      The object or array to iterate over.

    • callback: function

      The function that will be executed on every object.

        • (indexInArray: any, valueOfElement: any): any
        • Parameters

          • indexInArray: any
          • valueOfElement: any

          Returns any

    Returns any

error

  • error(message: any): JQuery
  • Takes a string and throws an exception containing it.

    Parameters

    • message: any

      The message to send out.

    Returns JQuery

extend

  • extend(target: any, object1?: any, ...objectN: any[]): any
  • extend(deep: boolean, target: any, object1?: any, ...objectN: any[]): any
  • Merge the contents of two or more objects together into the first object.

    Parameters

    • target: any

      An object that will receive the new properties if additional objects are passed in or that will extend the jQuery namespace if it is the sole argument.

    • Optional object1: any

      An object containing additional properties to merge in.

    • Rest ...objectN: any[]

      Additional objects containing properties to merge in.

    Returns any

  • Merge the contents of two or more objects together into the first object.

    Parameters

    • deep: boolean

      If true, the merge becomes recursive (aka. deep copy).

    • target: any

      The object to extend. It will receive the new properties.

    • Optional object1: any

      An object containing additional properties to merge in.

    • Rest ...objectN: any[]

      Additional objects containing properties to merge in.

    Returns any

get

  • Load data from the server using a HTTP GET request.

    Parameters

    • url: string

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

    • Optional success: function

      A callback function that is executed if the request succeeds.

        • (data: any, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • data: any
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    • Optional dataType: string

      The type of data expected from the server. Default: Intelligent Guess (xml, json, script, or html).

    Returns JQueryXHR

  • Load data from the server using a HTTP GET request.

    Parameters

    • url: string

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

    • Optional data: Object | string

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

    • Optional success: function

      A callback function that is executed if the request succeeds.

        • (data: any, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • data: any
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    • Optional dataType: string

      The type of data expected from the server. Default: Intelligent Guess (xml, json, script, or html).

    Returns JQueryXHR

  • Load data from the server using a HTTP GET request.

    Parameters

    Returns JQueryXHR

getJSON

  • getJSON(url: string, success?: function): JQueryXHR
  • getJSON(url: string, data?: Object | string, success?: function): JQueryXHR
  • Load JSON-encoded data from the server using a GET HTTP request.

    Parameters

    • url: string

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

    • Optional success: function

      A callback function that is executed if the request succeeds.

        • (data: any, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • data: any
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    Returns JQueryXHR

  • Load JSON-encoded data from the server using a GET HTTP request.

    Parameters

    • url: string

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

    • Optional data: Object | string

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

    • Optional success: function

      A callback function that is executed if the request succeeds.

        • (data: any, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • data: any
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    Returns JQueryXHR

getScript

  • getScript(url: string, success?: function): JQueryXHR
  • Load a JavaScript file from the server using a GET HTTP request, then execute it.

    Parameters

    • url: string

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

    • Optional success: function

      A callback function that is executed if the request succeeds.

        • (script: string, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • script: string
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    Returns JQueryXHR

globalEval

  • globalEval(code: string): any
  • Execute some JavaScript code globally.

    Parameters

    • code: string

      The JavaScript code to execute.

    Returns any

grep

  • grep<T>(array: T[], func: function, invert?: boolean): T[]
  • Finds the elements of an array which satisfy a filter function. The original array is not affected.

    Type parameters

    • T

    Parameters

    • array: T[]

      The array to search through.

    • func: function

      The function to process each item against. The first argument to the function is the item, and the second argument is the index. The function should return a Boolean value. this will be the global window object.

        • (elementOfArray?: T, indexInArray?: number): boolean
        • Parameters

          • Optional elementOfArray: T
          • Optional indexInArray: number

          Returns boolean

    • Optional invert: boolean

      If "invert" is false, or not provided, then the function returns an array consisting of all elements for which "callback" returns true. If "invert" is true, then the function returns an array consisting of all elements for which "callback" returns false.

    Returns T[]

hasData

  • hasData(element: Element): boolean
  • Determine whether an element has any jQuery data associated with it.

    Parameters

    • element: Element

      A DOM element to be checked for data.

    Returns boolean

holdReady

  • holdReady(hold: boolean): void
  • Holds or releases the execution of jQuery's ready event.

    Parameters

    • hold: boolean

      Indicates whether the ready hold is being requested or released

    Returns void

inArray

  • inArray<T>(value: T, array: T[], fromIndex?: number): number
  • Search for a specified value within an array and return its index (or -1 if not found).

    Type parameters

    • T

    Parameters

    • value: T

      The value to search for.

    • array: T[]

      An array through which to search.

    • Optional fromIndex: number

      he index of the array at which to begin the search. The default is 0, which will search the whole array.

    Returns number

isArray

  • isArray(obj: any): boolean
  • Determine whether the argument is an array.

    Parameters

    • obj: any

      Object to test whether or not it is an array.

    Returns boolean

isEmptyObject

  • isEmptyObject(obj: any): boolean
  • Check to see if an object is empty (contains no enumerable properties).

    Parameters

    • obj: any

      The object that will be checked to see if it's empty.

    Returns boolean

isFunction

  • isFunction(obj: any): boolean
  • Determine if the argument passed is a Javascript function object.

    Parameters

    • obj: any

      Object to test whether or not it is a function.

    Returns boolean

isNumeric

  • isNumeric(value: any): boolean
  • Determines whether its argument is a number.

    Parameters

    • value: any

    Returns boolean

isPlainObject

  • isPlainObject(obj: any): boolean
  • Check to see if an object is a plain object (created using "{}" or "new Object").

    Parameters

    • obj: any

      The object that will be checked to see if it's a plain object.

    Returns boolean

isWindow

  • isWindow(obj: any): boolean
  • Determine whether the argument is a window.

    Parameters

    • obj: any

      Object to test whether or not it is a window.

    Returns boolean

isXMLDoc

  • isXMLDoc(node: Node): boolean
  • Check to see if a DOM node is within an XML document (or is an XML document).

    Parameters

    • node: Node

      he DOM node that will be checked to see if it's in an XML document.

    Returns boolean

makeArray

  • makeArray(obj: any): any[]
  • Convert an array-like object into a true JavaScript array.

    Parameters

    • obj: any

      Any object to turn into a native Array.

    Returns any[]

map

  • map<T, U>(array: T[], callback: function): U[]
  • map(arrayOrObject: any, callback: function): any
  • Translate all items in an array or object to new array of items.

    Type parameters

    • T

    • U

    Parameters

    • array: T[]

      The Array to translate.

    • callback: function

      The function to process each item against. The first argument to the function is the array item, the second argument is the index in array The function can return any value. Within the function, this refers to the global (window) object.

        • (elementOfArray?: T, indexInArray?: number): U
        • Parameters

          • Optional elementOfArray: T
          • Optional indexInArray: number

          Returns U

    Returns U[]

  • Translate all items in an array or object to new array of items.

    Parameters

    • arrayOrObject: any

      The Array or Object to translate.

    • callback: function

      The function to process each item against. The first argument to the function is the value; the second argument is the index or key of the array or object property. The function can return any value to add to the array. A returned array will be flattened into the resulting array. Within the function, this refers to the global (window) object.

        • (value?: any, indexOrKey?: any): any
        • Parameters

          • Optional value: any
          • Optional indexOrKey: any

          Returns any

    Returns any

merge

  • merge<T>(first: T[], second: T[]): T[]
  • Merge the contents of two arrays together into the first array.

    Type parameters

    • T

    Parameters

    • first: T[]

      The first array to merge, the elements of second added.

    • second: T[]

      The second array to merge into the first, unaltered.

    Returns T[]

noConflict

  • Relinquish jQuery's control of the $ variable.

    Parameters

    • Optional removeAll: boolean

      A Boolean indicating whether to remove all jQuery variables from the global scope (including jQuery itself).

    Returns JQueryStatic

noop

  • noop(): any
  • An empty function.

    Returns any

now

  • now(): number
  • Return a number representing the current time.

    Returns number

parseHTML

  • parseHTML(data: string, context?: HTMLElement, keepScripts?: boolean): any[]
  • parseHTML(data: string, context?: Document, keepScripts?: boolean): any[]
  • Parses a string into an array of DOM nodes.

    Parameters

    • data: string

      HTML string to be parsed

    • Optional context: HTMLElement

      DOM element to serve as the context in which the HTML fragment will be created

    • Optional keepScripts: boolean

      A Boolean indicating whether to include scripts passed in the HTML string

    Returns any[]

  • Parses a string into an array of DOM nodes.

    Parameters

    • data: string

      HTML string to be parsed

    • Optional context: Document

      DOM element to serve as the context in which the HTML fragment will be created

    • Optional keepScripts: boolean

      A Boolean indicating whether to include scripts passed in the HTML string

    Returns any[]

parseJSON

  • parseJSON(json: string): any
  • Takes a well-formed JSON string and returns the resulting JavaScript object.

    Parameters

    • json: string

      The JSON string to parse.

    Returns any

parseXML

  • parseXML(data: string): XMLDocument
  • Parses a string into an XML document.

    Parameters

    • data: string

      a well-formed XML string to be parsed

    Returns XMLDocument

post

  • Load data from the server using a HTTP POST request.

    Parameters

    • url: string

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

    • Optional success: function

      A callback function that is executed if the request succeeds. Required if dataType is provided, but can be null in that case.

        • (data: any, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • data: any
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    • Optional dataType: string

      The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html).

    Returns JQueryXHR

  • Load data from the server using a HTTP POST request.

    Parameters

    • url: string

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

    • Optional data: Object | string

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

    • Optional success: function

      A callback function that is executed if the request succeeds. Required if dataType is provided, but can be null in that case.

        • (data: any, textStatus: string, jqXHR: JQueryXHR): any
        • Parameters

          • data: any
          • textStatus: string
          • jqXHR: JQueryXHR

          Returns any

    • Optional dataType: string

      The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html).

    Returns JQueryXHR

  • Load data from the server using a HTTP POST request.

    Parameters

    Returns JQueryXHR

proxy

  • proxy(fnction: function, context: Object, ...additionalArguments: any[]): any
  • proxy(context: Object, name: string, ...additionalArguments: any[]): any
  • Takes a function and returns a new one that will always have a particular context.

    Parameters

    • fnction: function

      The function whose context will be changed.

        • (...args: any[]): any
        • Parameters

          • Rest ...args: any[]

          Returns any

    • context: Object

      The object to which the context (this) of the function should be set.

    • Rest ...additionalArguments: any[]

      Any number of arguments to be passed to the function referenced in the function argument.

    Returns any

  • Takes a function and returns a new one that will always have a particular context.

    Parameters

    • context: Object

      The object to which the context (this) of the function should be set.

    • name: string

      The name of the function whose context will be changed (should be a property of the context object).

    • Rest ...additionalArguments: any[]

      Any number of arguments to be passed to the function named in the name argument.

    Returns any

queue

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

    Parameters

    • element: Element

      A DOM element to inspect for an attached queue.

    • 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 on the matched element.

    Parameters

    • element: Element

      A DOM element where the array of queued functions is attached.

    • 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 on the matched element.

    Parameters

    • element: Element

      A DOM element on which to add a queued function.

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

    Returns JQuery

removeData

  • removeData(element: Element, name?: string): JQuery
  • Remove a previously-stored piece of data.

    Parameters

    • element: Element

      A DOM element from which to remove data.

    • Optional name: string

      A string naming the piece of data to remove.

    Returns JQuery

trim

  • trim(str: string): string
  • Remove the whitespace from the beginning and end of a string.

    Parameters

    • str: string

      Remove the whitespace from the beginning and end of a string.

    Returns string

type

  • type(obj: any): string
  • Determine the internal JavaScript [[Class]] of an object.

    Parameters

    • obj: any

      Object to get the internal JavaScript [[Class]] of.

    Returns string

unique

  • unique(array: Element[]): Element[]
  • Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.

    Parameters

    • array: Element[]

      The Array of DOM elements.

    Returns Element[]

when

  • Provides a way to execute callback functions based on one or more objects, usually Deferred objects that represent asynchronous events.

    Type parameters

    • T

    Parameters

    • Rest ...deferreds: Array<T | JQueryPromise<T>>

      One or more Deferred objects, or plain JavaScript objects.

    Returns JQueryPromise<T>

Generated using TypeDoc