Revision 84921 of DOMStringMap

<p>{{ draft() }}</p>
<p>Used by the {{ htmlattrxref("dataset") }} HTML attribute to represent data for custom attributes added to elements.</p>
<h2 name="Method_overview">Method overview</h2>
<table class="standard-table"> <tbody> <tr> <td><code>DOMString <a href="#getDataAttr()">getDataAttr</a>(in DOMString prop);</code> {{ noscript_inline() }}</td> </tr> <tr> <td><code>boolean <a href="#hasDataAttr()">hasDataAttr</a>(in DOMString prop);</code> {{ notxpcom_inline() }}</td> </tr> <tr> <td><code>void <a href="#removeDataAttr()">removeDataAttr</a>(in DOMString prop);</code> {{ notxpcom_inline() }}</td> </tr> <tr> <td><code>void <a href="#removeProp()">removeProp</a>(in nsIAtom attr);</code> {{ notxpcom_inline() }}</td> </tr> <tr> <td><code>void <a href="#setDataAttr()">setDataAttr</a>(in DOMString prop, in DOMString value);</code> {{ noscript_inline() }}</td> </tr> </tbody>
</table>
<h2 name="Methods">Methods</h2>
<p>{{ method_noscript("getDataAttr") }}</p>
<pre class="eval">DOMString getDataAttr(
  in DOMString prop
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>prop</code></dt> <dd>The property for which to retrieve the value.</dd>
</dl>
<h6 name="Return_value">Return value</h6>
<p>The value for the specified property name.</p>
<p>{{ method_notxpcom("hasDataAttr") }}</p>
<pre class="eval">boolean hasDataAttr(
  in DOMString prop
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>prop</code></dt> <dd>The property for which to check for the existence of a value.</dd>
</dl>
<h6 name="Return_value">Return value</h6>
<p><code>true</code> if the property exists; otherwise <code>false</code>.</p>
<p>{{ method_notxpcom("removeDataAttr") }}</p>
<pre class="eval">void removeDataAttr(
  in DOMString prop
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>prop</code></dt> <dd>The property to remove from the data set.</dd>
</dl>
<p>{{ method_notxpcom("removeProp") }}</p>
<p>Removes the property from the dataset object. Used to update the dataset object when data-* attribute has been removed from the element.</p>
<pre class="eval">void removeProp(
  in nsIAtom attr
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>attr</code></dt> <dd>The property to remove from the dataset.</dd>
</dl>
<p>{{ method_noscript("setDataAttr") }}</p>
<p>Sets the value of the specified property.</p>
<pre class="eval">void setDataAttr(
  in DOMString prop,
  in DOMString value
);
</pre>
<h6 name="Parameters">Parameters</h6>
<dl> <dt><code>prop</code></dt> <dd>The property whose value is to be set.</dd> <dt><code>value</code></dt> <dd>The property's new value.</dd>
</dl>
<h2>See also</h2>
<ul> <li>{{ domxref("element.dataset") }}</li> <li>{{ htmlattrxref("dataset") }}</li>
</ul>