static
Class Get
Fetches and inserts one or more script or link nodes into the document
Properties
The number of request required before an automatic purge.
property PURGE_THRESH
Default Value: 20
Methods
static
void
abort
(
o
)
Abort a transaction
- Parameters:
-
o
<string|object>
Either the tId or the object returned from
script() or css()
- Returns:
void
static
tId: string
css
(
url
,
opts
)
Fetches and inserts one or more css link nodes into the
head of the current document or the document in a specified
window.
- Parameters:
-
url
<string>
the url or urls to the css file(s)
-
opts
<object>
Options:
- onSuccess
-
callback to execute when the css file(s) are finished loading
The callback receives an object back with the following
data:
win
- the window the link nodes(s) were inserted into
- data
- the data object passed in when the request was made
- nodes
- An array containing references to the nodes that were
inserted
- purge
- A function that, when executed, will remove the nodes
that were inserted
-
- context
- the execution context for the callbacks
- win
- a window other than the one the utility occupies
- data
-
data that is supplied to the callbacks when the nodes(s) are
loaded.
- insertBefore
- node or node id that will become the new node's nextSibling
- charset
- Node charset, default utf-8
Y.Get.css("http://yui.yahooapis.com/2.3.1/build/menu/assets/skins/sam/menu.css");
Y.Get.css(
["http://yui.yahooapis.com/2.3.1/build/menu/assets/skins/sam/menu.css",
"http://yui.yahooapis.com/2.3.1/build/logger/assets/skins/sam/logger.css"], {
insertBefore: 'custom-styles' // nodes will be inserted before the specified node
});
- Returns:
tId: string
- an object containing info about the transaction
static
tId: string
script
(
url
,
opts
)
Fetches and inserts one or more script nodes into the head
of the current document or the document in a specified window.
- Parameters:
-
url
<string|string[]>
the url or urls to the script(s)
-
opts
<object>
Options:
- onSuccess
-
callback to execute when the script(s) are finished loading
The callback receives an object back with the following
data:
- win
- the window the script(s) were inserted into
- data
- the data object passed in when the request was made
- nodes
- An array containing references to the nodes that were
inserted
- purge
- A function that, when executed, will remove the nodes
that were inserted
-
- onTimeout
-
callback to execute when a timeout occurs.
The callback receives an object back with the following
data:
- win
- the window the script(s) were inserted into
- data
- the data object passed in when the request was made
- nodes
- An array containing references to the nodes that were
inserted
- purge
- A function that, when executed, will remove the nodes
that were inserted
-
- onFailure
-
callback to execute when the script load operation fails
The callback receives an object back with the following
data:
- win
- the window the script(s) were inserted into
- data
- the data object passed in when the request was made
- nodes
- An array containing references to the nodes that were
inserted successfully
- purge
- A function that, when executed, will remove any nodes
that were inserted
-
- context
- the execution context for the callbacks
- win
- a window other than the one the utility occupies
- autopurge
-
setting to true will let the utilities cleanup routine purge
the script once loaded
- purgethreshold
-
The number of transaction before autopurge should be initiated
- data
-
data that is supplied to the callback when the script(s) are
loaded.
- insertBefore
- node or node id that will become the new node's nextSibling
- charset
- Node charset, default utf-8
- timeout
- Number of milliseconds to wait before aborting and firing the timeout event
Y.Get.script(
["http://yui.yahooapis.com/2.5.2/build/yahoo/yahoo-min.js",
"http://yui.yahooapis.com/2.5.2/build/event/event-min.js"], {
onSuccess: function(o) {
this.log("won't cause error because Y is the context");
Y.log(o.data); // foo
Y.log(o.nodes.length === 2) // true
// o.purge(); // optionally remove the script nodes immediately
},
onFailure: function(o) {
Y.log("transaction failed");
},
onTimeout: function(o) {
Y.log("transaction timed out");
},
data: "foo",
timeout: 10000, // 10 second timeout
context: Y, // make the YUI instance
// win: otherframe // target another window/frame
autopurge: true // allow the utility to choose when to remove the nodes
purgetheshold: 1 // purge previous transaction before next transaction
});
- Returns:
tId: string
- an object containing info about the transaction