NodeIterator

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Die NodeIterator-Schnittstelle repräsentiert einen Iterator zum Durchlaufen von Knoten eines DOM-Teilbaums in Dokumentreihenfolge.

Ein NodeIterator kann mit der Methode Document.createNodeIterator() wie folgt erstellt werden:

js
const nodeIterator = document.createNodeIterator(root, whatToShow, filter);

Instanzeigenschaften

Diese Schnittstelle erbt keine Eigenschaften.

NodeIterator.root Schreibgeschützt

Gibt einen Node zurück, der den Wurzelknoten darstellt, wie er bei der Erstellung des NodeIterator angegeben wurde.

NodeIterator.whatToShow Schreibgeschützt

Gibt eine unsigned long Bitmaske zurück, die die Typen von Node beschreibt, die übereinstimmen sollen. Nicht übereinstimmende Knoten werden übersprungen, aber relevante untergeordnete Knoten können einbezogen werden.

Die möglichen Bitmaskenwerte sind Konstanten aus der NodeFilter-Schnittstelle:

Konstante Numerischer Wert Beschreibung
NodeFilter.SHOW_ALL 4294967295 (das ist der Maximalwert von unsigned long) Zeigt alle Knoten.
NodeFilter.SHOW_ATTRIBUTE 2 Zeigt Attributknoten Attr an. Dies ist nur sinnvoll, wenn ein NodeIterator mit einem Attr-Knoten als Wurzel erstellt wird; in diesem Fall bedeutet es, dass der Attributknoten in der ersten Position der Iteration oder Durchlauf erscheint. Da Attribute niemals Kinder anderer Knoten sind, erscheinen sie nicht, wenn über den Dokumentbaum durchlaufen wird.
NodeFilter.SHOW_CDATA_SECTION 8 Zeigt CDATASection-Knoten an.
NodeFilter.SHOW_COMMENT 128 Zeigt Comment-Knoten an.
NodeFilter.SHOW_DOCUMENT 256 Zeigt Document-Knoten an.
NodeFilter.SHOW_DOCUMENT_FRAGMENT 1024 Zeigt DocumentFragment-Knoten an.
NodeFilter.SHOW_DOCUMENT_TYPE 512 Zeigt DocumentType-Knoten an.
NodeFilter.SHOW_ELEMENT 1 Zeigt Element-Knoten an.
NodeFilter.SHOW_ENTITY 32 Veraltet, wird nicht mehr verwendet.
NodeFilter.SHOW_ENTITY_REFERENCE 16 Veraltet, wird nicht mehr verwendet.
NodeFilter.SHOW_NOTATION 2048 Veraltet, wird nicht mehr verwendet.
NodeFilter.SHOW_PROCESSING_INSTRUCTION 64 Zeigt ProcessingInstruction-Knoten an.
NodeFilter.SHOW_TEXT 4 Zeigt Text-Knoten an.
NodeIterator.filter Schreibgeschützt

Gibt einen NodeFilter zurück, der verwendet wird, um die relevanten Knoten auszuwählen.

NodeIterator.referenceNode Schreibgeschützt

Gibt den Node zurück, an dem der Iterator verankert ist.

NodeIterator.pointerBeforeReferenceNode Schreibgeschützt

Gibt einen Booleschen Wert zurück, der angibt, ob der NodeIterator vor dem NodeIterator.referenceNode verankert ist oder nicht. Wenn false, bedeutet es, dass der Iterator nach dem Referenzknoten verankert ist.

Instanzmethoden

Diese Schnittstelle erbt keine Methoden.

NodeIterator.detach()

Dies ist eine veraltete Methode und hat keine Auswirkungen mehr. Früher diente sie dazu, einen NodeIterator als entsorgt zu kennzeichnen, sodass er vom Garbage Collector zurückgefordert werden konnte.

NodeIterator.previousNode()

Gibt den vorherigen Node im Dokument zurück, oder null, wenn keiner vorhanden ist.

NodeIterator.nextNode()

Gibt den nächsten Node im Dokument zurück, oder null, wenn keiner vorhanden ist.

Spezifikationen

Specification
DOM
# interface-nodeiterator

Browser-Kompatibilität

Siehe auch