2014-09-05 11:57:18 -04:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Namespace: dom< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Namespace: dom< / h1 >
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "$_.html" > $_< / a > .< / span >
dom
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< div class = "description" > DOM
Dom manipulation module< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line81" > line 81< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< / div >
2014-09-12 16:14:12 -04:00
2014-09-05 11:57:18 -04:00
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "addClass" > < span class = "type-signature" > (static) < / span > addClass< span class = "signature" > (class)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Adds a class to the element(s) specified by the current
selector
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > class< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line90" > line 90< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "append" > < span class = "type-signature" > (static) < / span > append< span class = "signature" > (htm)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Adds to the innerHTML of the current element, after the last child.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > htm< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line256" > line 256< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > $_("ul").dom.append("& lt;li& gt;& lt;/li& gt;") adds an li element to the end of the selected ul element< / code > < / pre >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "attr" > < span class = "type-signature" > (static) < / span > attr< span class = "signature" > (name, value< span class = "signature-attributes" > opt, nullable< / span > )< / span > < span class = "type-signature" > → (nullable) {string}< / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Sets attributes on element(s) specified by the current
selector, or, if name is not specified, returns the
value of the attribute of the element specified by the
current selector.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-09-12 16:14:12 -04:00
< th > Attributes< / th >
2014-09-05 11:57:18 -04:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< nullable>< br >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line151" > line 151< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "css" > < span class = "type-signature" > (static) < / span > css< span class = "signature" > (property, value< span class = "signature-attributes" > opt, nullable< / span > )< / span > < span class = "type-signature" > → (nullable) {string}< / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Sets or retrieves a css property of the element
specified by the current selector. If a value is
passed, it will set that value on the current element,
otherwise it will return the value of the css property
on the current element.
Accepts either key/value arguments, or an object with
multiple key/value pairs.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-09-12 16:14:12 -04:00
< th > Attributes< / th >
2014-09-05 11:57:18 -04:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > property< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > Object< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< nullable>< br >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line216" > line 216< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "hide" > < span class = "type-signature" > (static) < / span > hide< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Hides the element(s) specified by the current selector
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line120" > line 120< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "html" > < span class = "type-signature" > (static) < / span > html< span class = "signature" > (htm< span class = "signature-attributes" > opt, nullable< / span > )< / span > < span class = "type-signature" > → (nullable) {string}< / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Sets or gets the innerHTML propery of the element(s) passed
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-09-12 16:14:12 -04:00
< th > Attributes< / th >
2014-09-05 11:57:18 -04:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > htm< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< nullable>< br >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line281" > line 281< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "prepend" > < span class = "type-signature" > (static) < / span > prepend< span class = "signature" > (htm)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Adds to the innerHTML of the selected element, before the current children
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > htm< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line269" > line 269< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "removeClass" > < span class = "type-signature" > (static) < / span > removeClass< span class = "signature" > (class)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Removes a class from the element(s) specified by the current
selector
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > class< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line105" > line 105< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "show" > < span class = "type-signature" > (static) < / span > show< span class = "signature" > (type< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Shows the element(s) specified by the current selector.
if type is specified, the element will have it's style
property set to "display:[your type]". If type is not
specified, the element is set to "display:block".
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-09-12 16:14:12 -04:00
< th > Attributes< / th >
2014-09-05 11:57:18 -04:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line131" > line 131< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-09-12 16:14:12 -04:00
< h4 class = "name" id = "text" > < span class = "type-signature" > (static) < / span > text< span class = "signature" > (value< span class = "signature-attributes" > opt, nullable< / span > )< / span > < span class = "type-signature" > → (nullable) {string}< / span > < / h4 >
2014-09-05 11:57:18 -04:00
< / dt >
< dd >
< div class = "description" >
Sets or retrieves the text content of the element
specified by the current selector. If a value is
passed, it will set that value on the current element,
otherwise it will return the value of the current element
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-09-12 16:14:12 -04:00
< th > Attributes< / th >
2014-09-05 11:57:18 -04:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< nullable>< br >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-09-12 16:14:12 -04:00
< a href = "DOM.js.html" > modules/DOM.js< / a > , < a href = "DOM.js.html#line184" > line 184< / a >
2014-09-05 11:57:18 -04:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< nav >
2014-09-12 16:14:12 -04:00
< h2 > < a href = "index.html" > Index< / a > < / h2 > < h3 > Namespaces< / h3 > < ul > < li > < a href = "$_.html" > $_< / a > < / li > < li > < a href = "$_.dom.html" > dom< / a > < / li > < li > < a href = "$_.event.html" > event< / a > < / li > < li > < a href = "$_.store.html" > store< / a > < / li > < / ul >
2014-09-05 11:57:18 -04:00
< / nav >
< br clear = "both" >
< footer >
2014-09-12 16:14:12 -04:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-alpha9< / a > on Fri Sep 12 2014 16:11:50 GMT-0400 (EDT)
2014-09-05 11:57:18 -04:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
