Jquery Data

.
data( key, value )Returns: jQuery

Description: Store arbitrary data associated with the matched elements.
version added: 1.2.3.data( key, value )

key
Type: String
A string naming the piece of data to set.
value
Type: Anything
The new data value; this can be any Javascript type except undefined.
version added: 1.4.3.data( obj )

obj
Type: Object
An object of key-value pairs of data to update.
The .data() method allows us to attach data of any type to DOM elements in a way that is safe
from circular references and therefore from memory leaks.
We can set several distinct values for a single element and retrieve them later:
1
2
3
4
$(
$(
$(
$(
$(
"body"
"body"
"body"
"body"
"body"
).data( "foo", 52 );
).data( "bar", { myType: "test", count: 40 } );
).data( { baz: [ 1, 2, 3 ] } );
).data( "foo" ); // 52
).data(); // { foo: 52, bar: { myType: "test", count: 40 }, baz: [ 1, 2
In jQuery 1.4.3 setting an element's data object with .data(obj) extends the data previously
stored with that element.
Prior to jQuery 1.4.3 (starting in jQuery 1.4) the .data() method completely replaced all data,
instead of just extending the data object. If you are using third-party plugins it may not be
advisable to completely replace the element's data object, since plugins may have also set data.
Due to the way browsers interact with plugins and external code, the .data() method cannot be
used on <object> (unless it's a Flash plugin), <applet> or <embed> elements.
Additional Notes:
Note that this method currently does not provide cross-platform support for
setting data on XML documents, as Internet Explorer does not allow data to be
attached via expando properties.
undefined is not recognized as a data value. Calls such as .data( "name",

undefined ) will return the jQuery object that it was called on, allowing for
chaining.
Example:
Store then retrieve a value from the div element.
1
2
3
4
5
6
7
8
9
10
11
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>data demo</title>
<style>
div {
color: blue;
}
span {
color: red;
}
</style>
<script src="https://code.jquery.com/jquery-1.10.2.js"></script>
</head>
<body>
<div>
The values stored were
<span></span>
and
<span></span>
</div>
<script>
$( "div" ).data( "test", { first: 16, last: "pizza!" } );
$( "span:first" ).text( $( "div" ).data( "test" ).first );
$( "span:last" ).text( $( "div" ).data( "test" ).last );
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
</script>
</body>
</html>
Demo:
.data( key )Returns: Object

Description: Return the value at the named data store for the first element in the jQuery
collection, as set by data(name, value) or by an HTML5 data-* attribute.
version added: 1.2.3.data( key )

key
Type: String
Name of the data stored.
version added: 1.4.data()

This signature does not accept any arguments.
The .data() method allows us to attach data of any type to DOM elements in a way that is safe
from circular references and therefore from memory leaks. We can retrieve several distinct
values for a single element one at a time, or as a set:
1
2
alert( $( "body" ).data( "foo" ) );

alert( $( "body" ).data() );
The above lines alert the data values that were set on the body element. If no data at all was set
on that element, undefinedis returned.
1
2
alert( $( "body" ).data( "foo" ) ); // undefined

$( "body" ).data( "bar", "foobar" );
alert( $( "body" ).data( "bar" ) ); // foobar
3
HTML5 data-* Attributes
As of jQuery 1.4.3 HTML 5 data- attributes will be automatically pulled in to jQuery's data
object. The treatment of attributes with embedded dashes was changed in jQuery 1.6 to conform
to the W3C HTML5 specification.
For example, given the following HTML:
<div data-role="page" data-last-value="43" data-hidden="true" data-options='{"nam
All of the following jQuery code will work.
1
2
3
$(
$(
$(
$(
"div"
"div"
"div"
"div"
).data(
).data(
).data(
).data(
"role" ) === "page";

"lastValue" ) === 43;
"hidden" ) === true;
"options" ).name === "John";
The second statement of the code above correctly refers to the data-last-value attribute of the
element. In case no data is stored with the passed key, jQuery searches among the attributes of
the element, converting a camel-cased string into a dashed string and then prepending data- to
the result. So, the string lastValue is converted to data-last-value.
Every attempt is made to convert the string to a JavaScript value (this includes booleans,
numbers, objects, arrays, and null). A value is only converted to a number if doing so doesn't
change the value's representation. For example, "1E02" and "100.000" are equivalent as numbers
(numeric value 100) but converting them would alter their representation so they are left as
strings. The string value "100" is converted to the number 100.
When the data attribute is an object (starts with '{') or array (starts with '[')
then jQuery.parseJSON is used to parse the string; it must follow valid JSON syntax including
quoted property names. If the value isn't parseable as a JavaScript value, it is left as a string.
To retrieve the value's attribute as a string without any attempt to convert it, use
the attr() method.
The data- attributes are pulled in the first time the data property is accessed and then are no
longer accessed or mutated (all data values are then stored internally in jQuery).
Calling .data() with no parameters retrieves all of the values as a JavaScript object. This object
can be safely cached in a variable as long as a new object is not set with .data(obj). Using the
object directly to get or set values is faster than making individual calls to .data() to get or set
each value:

Jquery Data

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Jquery Data

Uploaded by

Copyright:

Available Formats

.

data( key, value )Returns: jQuery

version added: 1.2.3.data( key, value )

version added: 1.4.3.data( obj )

undefined is not recognized as a data value. Calls such as .data( "name",

.data( key )Returns: Object

version added: 1.2.3.data( key )

version added: 1.4.data()

alert( $( "body" ).data( "foo" ) );

alert( $( "body" ).data( "foo" ) ); // undefined

For example, given the following HTML:

<div data-role="page" data-last-value="43" data-hidden="true" data-options='{"nam

All of the following jQuery code will work.

"role" ) === "page";

You might also like