Node.setUserData()

Die Methode Node.setUserData()erlaubt es dem Benutzer Daten dem Element hinzuzufügen (oder löschen), ohne dabei die DOM zu modifizieren. Beachte dabei, dass die Daten durch das Nutzen von Node.importNode, Node.cloneNode() und Node.renameNode() nicht mitgegeben werden kann (jedoch kann Node.adoptNode die Information behalten), und bei Vergleichstest mit Node.isEqualNode() werden die Daten nicht berücksichtigt.

This method offers the convenience of associating data with specific nodes without needing to alter the structure of a document and in a standard fashion, but it also means that extra steps may need to be taken if one wishes to serialize the information or include the information upon clone, import, or rename operations.

Syntax

var prevUserData = someNode.setUserData(userKey, userData, handler);

Parameters

• userKey is used as the key by which one may subsequently obtain the stored data. More than one key can be set for a given node.
• handler is a callback which will be called any time the node is being cloned, imported, renamed, as well as if deleted or adopted; a function can be used or an object implementing the handle method (part of the UserDataHandler interface). The handler will be passed five arguments: an operation type integer (e.g., 1 to indicate a clone operation), the user key, the data on the node, the source node (null if being deleted), the destination node (the newly created node or null if none).If no handler is desired, one must specify null.
• userData is the object to associate to userKey on someNode. If null, any previously registered object and UserDataHandler associated to userKey on this node will be removed.

Beispiel

var d = document.implementation.createDocument('', 'test', null); 
d.documentElement.setUserData('key', 15, {handle:function (o, k, d, s, ds) {console.log(o+'::'+k+'::'+d+'::'+s+'::'+ds)}}); // 2::key::15::[object Element]::[object Element]
console.log(d.documentElement.getUserData('key')); // 15
var e = document.importNode(d.documentElement, true); // causes handler to be called
console.log(e.getUserData('key')); // null since user data is not copied

Spezifikationen

Browser Kompabilität

[1] The method is still available from within chrome scripts.

Siehe auch

• Node.getUserData()
• UserDataHandler
• DOMUserData