Dokument: createNodeIterator() Methode

Syntax

createNodeIterator(root)
createNodeIterator(root, whatToShow)
createNodeIterator(root, whatToShow, filter)

Parameter

root

Der Stammknoten, bei dem der Durchlauf des NodeIterator beginnen soll.

whatToShow Optional

Ein optionaler unsigned long, der eine Bitmaske darstellt, erstellt durch das Kombinieren der Konstanten-Eigenschaften von NodeFilter. Es ist eine bequeme Möglichkeit, bestimmte Knotentypen zu filtern. Standardwert ist 0xFFFFFFFF, das die Konstante SHOW_ALL darstellt.

Konstante	Zahlenwert	Beschreibung
NodeFilter.SHOW_ALL	0xFFFFFFFF	Zeigt alle Knoten an.
NodeFilter.SHOW_ATTRIBUTE	0x2	Zeigt Attr-Knoten an.
NodeFilter.SHOW_CDATA_SECTION	0x8	Zeigt CDATASection-Knoten an.
NodeFilter.SHOW_COMMENT	0x80	Zeigt Comment-Knoten an.
NodeFilter.SHOW_DOCUMENT	0x100	Zeigt Document-Knoten an.
NodeFilter.SHOW_DOCUMENT_FRAGMENT	0x400	Zeigt DocumentFragment-Knoten an.
NodeFilter.SHOW_DOCUMENT_TYPE	0x200	Zeigt DocumentType-Knoten an.
NodeFilter.SHOW_ELEMENT	0x1	Zeigt Element-Knoten an.
NodeFilter.SHOW_ENTITY Veraltet	0x20	Veraltet, nicht mehr wirksam.
NodeFilter.SHOW_ENTITY_REFERENCE Veraltet	0x10	Veraltet, nicht mehr wirksam.
NodeFilter.SHOW_NOTATION Veraltet	0x800	Veraltet, nicht mehr wirksam.
NodeFilter.SHOW_PROCESSING_INSTRUCTION	0x40	Zeigt ProcessingInstruction-Knoten an.
NodeFilter.SHOW_TEXT	0x4	Zeigt Text-Knoten an.

Hinweis: Die Konstante NodeFilter.SHOW_ATTRIBUTE ist nur wirksam, wenn der Stamm ein Attributknoten ist. Da das übergeordnete Element eines Attr-Knotens immer null ist, geben TreeWalker.nextNode() und TreeWalker.previousNode() niemals einen Attr-Knoten zurück. Um Attr-Knoten zu durchlaufen, verwenden Sie stattdessen Element.attributes.

filter Optional

Eine Callback-Funktion oder ein Objekt mit einer acceptNode()-Methode. Die Funktion oder Methode wird für jeden Knoten im Teilbaum, der am Stamm basiert und als in die Liste der durchlaufbaren Knoten aufgenommen akzeptiert wird, aufgerufen, um zu bestimmen, ob er aufgenommen werden soll oder nicht. Die Methode sollte eines der NodeFilter.FILTER_ACCEPT, NodeFilter.FILTER_REJECT oder NodeFilter.FILTER_SKIP zurückgeben. Siehe das Beispiel.

Für createNodeIterator sind die Werte NodeFilter.FILTER_REJECT und NodeFilter.FILTER_SKIP gleichwertig. Dieser Knoten wird nicht in die Liste der durchlaufbaren Knoten aufgenommen, aber seine Kinder werden weiterhin durchlaufen.

Rückgabewert

Ein neues NodeIterator-Objekt.

Beispiele

const nodeIterator = document.createNodeIterator(
  document.body,
  NodeFilter.SHOW_ELEMENT,
  (node) =>
    node.nodeName.toLowerCase() === "p"
      ? NodeFilter.FILTER_ACCEPT
      : NodeFilter.FILTER_REJECT,
);
const pars = [];
let currentNode;

while ((currentNode = nodeIterator.nextNode())) {
  pars.push(currentNode);
}

Dasselbe, jedoch unter Verwendung eines Objekts mit einer acceptNode()-Methode:

const nodeIterator = document.createNodeIterator(
  document.body,
  NodeFilter.SHOW_ELEMENT,
  {
    acceptNode(node) {
      return node.nodeName.toLowerCase() === "p"
        ? NodeFilter.FILTER_ACCEPT
        : NodeFilter.FILTER_REJECT;
    },
  },
);
const pars = [];
let currentNode;

while ((currentNode = nodeIterator.nextNode())) {
  pars.push(currentNode);
}

Spezifikationen

Browser-Kompatibilität