MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-survey

La méthode de création Document.createTreeWalker() renvoie un nouvel objet TreeWalker.

Syntaxe

treeWalker = document.createTreeWalker(root, whatToShow, filter, entityReferenceExpansion);

Paramètres

root
est le Node (noeud) racine du TreeWalker à traverser. Généralement, ce sera un élément appartenant au document.
whatToShow Facultatif
est un unsigned long (long non signé) facultatif représentant un masque de bits créé par combinaison des propriétés de constante de NodeFilter. C'est un moyen pratique de filtrage pour certains types de nœuds. Par défaut 0xFFFFFFFF représentant la constante SHOW_ALL.
Constante Valeur numérique Description
NodeFilter.SHOW_ALL -1 (c'est la valeur numérique maximale du unsigned long (non signé long)) Affiche tous les noeuds.
NodeFilter.SHOW_ATTRIBUTE 2 Affiche l'attribut Attr des noeuds. Cela n'a de sens que lors de la création d'un TreeWalker avec un noeud Attr comme racine ; dans ce cas, cela signifie que le nœud d'attribut apparaîtra dans la première position de l'itération ou de la traversée. Comme les attributs ne sont jamais des enfants d'autres nœuds, ils n'apparaissent pas lors de la traversée de l'arbre du document.
NodeFilter.SHOW_CDATA_SECTION 8 Affiche les noeuds CDATASection.
NodeFilter.SHOW_COMMENT 128 Affiche les noeuds Comment.
NodeFilter.SHOW_DOCUMENT 256 Affiche les noeuds Document.
NodeFilter.SHOW_DOCUMENT_FRAGMENT 1024 Affiche les noeuds DocumentFragment.
NodeFilter.SHOW_DOCUMENT_TYPE 512 Affiche les noeuds DocumentType.
NodeFilter.SHOW_ELEMENT 1 Affiche les noeuds Element.
NodeFilter.SHOW_ENTITY 32 Affiche les noeuds Entity. Cela n'a de sens que lors de la création d'un TreeWalker avec un noeud Entity comme racine ; dans ce cas, il signifie que le noeud d'entité Entity apparaîtra à la première position de la traversée. Étant donné que les entités ne font pas partie de l'arborescence du document, elles n'apparaissent pas lors de la traversée de l'arborescence du document.
NodeFilter.SHOW_ENTITY_REFERENCE 16 Affiche les noeuds EntityReference.
NodeFilter.SHOW_NOTATION 2048 Affiche les noeuds Notation. Cela n'a de sens que lors de la création d'un TreeWalker avec un noeud Notation comme racine ; dans ce cas, il signifie que le noeud Notation apparaîtra à la première position de la traversée. Étant donné que les entités ne font pas partie de l'arborescence du document, elles n'apparaissent pas lors de la traversée de l'arborescence du document.
NodeFilter.SHOW_PROCESSING_INSTRUCTION 64 Affiche les noeuds ProcessingInstruction.
NodeFilter.SHOW_TEXT 4 Affiche les noeuds Text.
filter Facultatif
est un NodeFilter (filtre de noeud) facultatif, c'est à dire un objet avec une méthode acceptNode appelé par TreeWalker pour déterminer s'il doit accepter ou non un nœud qui a passé le test whatToShow.
entityReferenceExpansion Facultatif
est un Boolean (booléen) indiquant si, lors de la suppression d'une EntityReference, son sous-arbre doit être supprimé en même temps.

Exemple

L'exemple suivant passe à travers tous les noeuds du "body" (corps du document), réduit l'ensemble des noeuds aux éléments, passe simplement à travers chaque noeud acceptable (à la place, il pourrait réduire l'ensemble dans la méthode acceptNode()), puis utilise l'itérateur de traversée de l'arbre créé pour avancer à travers les nœuds (maintenant tous les éléments) et les écrire dans un tableau.

var treeWalker = document.createTreeWalker(
  document.body,
  NodeFilter.SHOW_ELEMENT,
  { acceptNode: function(node) { return NodeFilter.FILTER_ACCEPT; } },
  false
);

var nodeList = [];

while(treeWalker.nextNode()) nodeList.push(treeWalker.currentNode);

Spécifications

Spécification Statut Commentaire
DOM
La définition de 'Document.createTreeWalker' dans cette spécification.
Standard évolutif Suppression du paramètre expandEntityReferences. Les paramètres facultatifs  whatToShow et filter .
Document Object Model (DOM) Level 2 Traversal and Range Specification
La définition de 'Document.createTreeWalker' dans cette spécification.
Obsolete Définition initiale.

Compatibilité des navigateurs

Nous convertissons les données de compatibilité dans un format JSON. Ce tableau de compatibilité utilise encore l'ancien format car nous n'avons pas encore converti les données qu'il contient. Vous pouvez nous aider en contribuant !

        
Fonctionnalité Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
Basic support 1.0 (Oui) 2.0 (1.8.1) 9.0 9.0 3.0
whatToShow and filter optional 1.0 ? 12 (12) Pas de support (Oui) 3.0
expandEntityReferences 1.0 ? 2.0 (1.8.1)
Removed in 12 (12)
9.0 9.0 3.0
        
Fonctionnalité Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Oui) (Oui) 1.0 (1.8.1) (Oui) 9.0 3.0
whatToShow and filter optional (Oui) ? 12 (12) Pas de support (Oui) 3.0
expandEntityReferences (Oui) ? 2.0 (1.8.1)
Removed in 12 (12)
(Oui) 9.0 3.0

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : loella16
 Dernière mise à jour par : loella16,