-
Notifications
You must be signed in to change notification settings - Fork 4
API: Basic methods
Except where otherwise stated, all methods return the AOMI object itself, to allow method chaining.
Returns the body element of the iframe’s document, wrapped in a jQuery object.
If the body element cannot be accessed (e.g. because the iframe is not in the DOM, or the iframe is displaying a document from a different domain), then an an empty jQuery collection, with zero length, is returned.
-
contentswill be appended to the iframe’sbodyelement. May be an HTML string, DOM node, jQuery collection, or selector. -
emptyFirstis an optional boolean (defaultfalse). Iftrue, the body element will first be emptied of all child nodes.
Returns the head element of the iframe’s document, wrapped in a jQuery object.
If the head element cannot be accessed (e.g. because the iframe is not in the DOM, or the iframe is displaying a document from a different domain), then an an empty jQuery collection, with zero length, is returned.
-
contentswill be appended to the iframe’sheadelement. May be an HTML string, DOM node, jQuery collection, or selector. -
emptyFirstis an optional boolean (defaultfalse). Iftrue, the head element will first be emptied of all child nodes.
Returns the iframe’s window object, wrapped in a jQuery object.
If the window object cannot be accessed (e.g. because the iframe is not in the DOM, or the iframe is displaying a document from a different domain), then an an empty jQuery collection, with zero length, is returned.
Returns the iframe’s document object, wrapped in a jQuery object.
If the document object cannot be accessed (e.g. because the iframe is not in the DOM, or the iframe is displaying a document from a different domain), then an an empty jQuery collection, with zero length, is returned.
A shortcut for document(). This is analagous to the jQuery method $.(), which returns the global document object.
Returns a set of elements from the iframe’s document body, matching the CSS selector.
This identical to: jQuery(selector, aomi.body())
Returns the iframe document’s doctype string, e.g. <!DOCTYPE html>.
Sets the AOMI object’s doctype option to the new HTML version, e.g. aomi.doctype(5); for HTML5. The doctype is used when the iframe document is created.
Returns the iframe window’s location, if it can be determined (this will happen if the iframe is in the DOM and it has a document from the same domain as the host document). If not, then the method will either return the iframe element’s src attribute (if the iframe is out of the DOM and has a document from the same domain as the host document), or otherwise null.
Appends contents to the iframe document’s head and body.
Shortcut for aomi.head(headContents, emptyFirst).body(bodyContents, emptyFirst).