Document.createTreeWalker()

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 Obsolète	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 Obsolète	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 Obsolète	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 Obsolète	16	Affiche les noeuds EntityReference.
NodeFilter.SHOW_NOTATION Obsolète	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 Obsolète

est un Boolean (booléen) indiquant si, lors de la suppression d'une EntityReference, son sous-arbre doit être supprimé en même temps.

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);

• L'interface de l'objet qu'il crée : TreeWalker.