Interface JQueryStatic

interface JQueryStatic {
    xutil: XUtil;
    (window: Window, discriminator: boolean): JQueryStatic;
    <TElement extends HTMLElement = HTMLElement>(
        html: string,
        ownerDocument_attributes?: Document | PlainObject<any>,
    ): JQuery<TElement>;
    <TElement extends Element = HTMLElement>(
        selector: string,
        context?: string | Element | Document | JQuery<HTMLElement>,
    ): JQuery<TElement>;
    (element: HTMLSelectElement): JQuery<HTMLSelectElement>;
    <T extends Element>(element_elementArray: T | ArrayLike<T>): JQuery<T>;
    <T>(selection: JQuery<T>): JQuery<T>;
    <TElement = HTMLElement>(
        callback: (this: Document, $: JQueryStatic) => void,
    ): JQuery<TElement>;
    <T extends PlainObject<any>>(object: T): JQuery<T>;
    <TElement = HTMLElement>(): JQuery<TElement>;
}

JQueryStatic(window: Window, discriminator: boolean): JQueryStatic
Parameters
- window: Window
- discriminator: boolean
Returns JQueryStatic
JQueryStatic<TElement extends HTMLElement = HTMLElement>(
html: string,
ownerDocument_attributes?: Document | PlainObject<any>,
): JQuery<TElement>
Creates DOM elements on the fly from the provided string of raw HTML.
Type Parameters
- TElement extends HTMLElement = HTMLElement
Parameters
- html: string
  @param html
  
  html (ownerDocument) — A string of HTML to create on the fly. Note that this parses HTML, not XML.
  
  html (attributes) — A string defining a single, standalone, HTML element (e.g. <div/> or <div></div>).
- OptionalownerDocument_attributes: Document | PlainObject<any>
  @param ownerDocument_attributes
  
  ownerDocument — A document in which the new elements will be created.
  
  attributes — An object of attributes, events, and methods to call on the newly-created element.
Returns JQuery<TElement>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0

Since
1.4
Example: Create a div element (and all of its contents) dynamically and append it to the body element. Internally, an element is created and its innerHTML property set to the given markup.
```
$( "<div><p>Hello</p></div>" ).appendTo( "body" )
```
Example: Create some DOM elements.
```
$( "<div/>", {
"class": "test",
text: "Click me!",
click: function() {
$( this ).toggleClass( "test" );
}
})
.appendTo( "body" );
```
JQueryStatic<TElement extends Element = HTMLElement>(
selector: string,
context?: string | Element | Document | JQuery<HTMLElement>,
): JQuery<TElement>
Accepts a string containing a CSS selector which is then used to match a set of elements.
Type Parameters
- TElement extends Element = HTMLElement
Parameters
- selector: string
  A string containing a selector expression
- Optionalcontext: string | Element | Document | JQuery<HTMLElement>
  A DOM Element, Document, Selector or jQuery to use as context
Returns JQuery<TElement>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0
Example: Find all p elements that are children of a div element and apply a border to them.
```
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>jQuery demo</title>
<script src="https://code.jquery.com/jquery-3.3.1.js"></script>
</head>
<body>

<p>one</p>
<div><p>two</p></div>
<p>three</p>

<script>
$( "div > p" ).css( "border", "1px solid gray" );
</script>
</body>
</html>
```
Example: Find all inputs of type radio within the first form in the document.
```
$( "input:radio", document.forms[ 0 ] );
```
Example: Find all div elements within an XML document from an Ajax response.
```
$( "div", xml.responseXML );
```
JQueryStatic(element: HTMLSelectElement): JQuery<HTMLSelectElement>
Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string.
Parameters
- element: HTMLSelectElement
  A DOM element to wrap in a jQuery object.
Returns JQuery<HTMLSelectElement>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0
Example: Set the background color of the page to black.
```
$( document.body ).css( "background", "black" );
```
JQueryStatic<T extends Element>(
element_elementArray: T | ArrayLike<T>,
): JQuery<T>
Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string.
Type Parameters
- T extends Element
Parameters
- element_elementArray: T | ArrayLike<T>
  @param element_elementArray
  
  element — A DOM element to wrap in a jQuery object.
  
  elementArray — An array containing a set of DOM elements to wrap in a jQuery object.
Returns JQuery<T>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0
Example: Set the background color of the page to black.
```
$( document.body ).css( "background", "black" );
```
Example: Hide all the input elements within a form.
```
$( myForm.elements ).hide();
```
JQueryStatic<T>(selection: JQuery<T>): JQuery<T>
Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string.
Type Parameters
- T
Parameters
- selection: JQuery<T>
  An existing jQuery object to clone.
Returns JQuery<T>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0
JQueryStatic<TElement = HTMLElement>(
callback: (this: Document, $: JQueryStatic) => void,
): JQuery<TElement>
Binds a function to be executed when the DOM has finished loading.
Type Parameters
- TElement = HTMLElement
Parameters
- callback: (this: Document, $: JQueryStatic) => void
  The function to execute when the DOM is ready.
Returns JQuery<TElement>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0
Example: Execute the function when the DOM is ready to be used.
```
$(function() {
// Document is ready
});
```
Example: Use both the shortcut for $(document).ready() and the argument to write failsafe jQuery code using the $ alias, without relying on the global alias.
```
jQuery(function( $ ) {
// Your code using failsafe $ alias here...
});
```
JQueryStatic<T extends PlainObject<any>>(object: T): JQuery<T>
Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string.
Type Parameters
- T extends PlainObject<any>
Parameters
- object: T
  A plain object to wrap in a jQuery object.
Returns JQuery<T>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.0
JQueryStatic<TElement = HTMLElement>(): JQuery<TElement>
Returns an empty jQuery set.
Type Parameters
- TElement = HTMLElement
Returns JQuery<TElement>
See
<a href="https://api.jquery.com/jQuery/">https://api.jquery.com/jQuery/</a>

Since
1.4

Index

Properties

xutil

Properties

xutil

xutil: XUtil

Contains static utility functions used by XIMA formcycle.

Interface JQueryStatic

Parameters

Returns JQueryStatic

Type Parameters

Parameters

Returns JQuery<TElement>

See

Since

Since

Example: Create a div element (and all of its contents) dynamically and append it to the body element. Internally, an element is created and its innerHTML property set to the given markup.

Example: Create some DOM elements.

Type Parameters

Parameters

Returns JQuery<TElement>

See

Since

Example: Find all p elements that are children of a div element and apply a border to them.

Example: Find all inputs of type radio within the first form in the document.

Example: Find all div elements within an XML document from an Ajax response.

Parameters

Returns JQuery<HTMLSelectElement>

See

Since

Example: Set the background color of the page to black.

Type Parameters

Parameters

Returns JQuery<T>

See

Since

Example: Set the background color of the page to black.

Example: Hide all the input elements within a form.

Type Parameters

Parameters

Returns JQuery<T>

See

Since

Type Parameters

Parameters

Returns JQuery<TElement>

See

Since

Example: Execute the function when the DOM is ready to be used.

Example: Use both the shortcut for $(document).ready() and the argument to write failsafe jQuery code using the $ alias, without relying on the global alias.

Type Parameters

Parameters

Returns JQuery<T>

See

Since

Type Parameters

Returns JQuery<TElement>

See

Since

Index

Properties

Properties

xutil

Settings

On This Page