TreeWalker

Baseline Widely available

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

Das TreeWalker-Objekt repräsentiert die Knoten eines Dokument-Unterbaums und eine Position innerhalb dieser.

Ein TreeWalker kann mittels der Methode Document.createTreeWalker() erstellt werden.

Instanz-Eigenschaften

Diese Schnittstelle erbt keine Eigenschaften.

TreeWalker.root Schreibgeschützt

Gibt den Wurzel-Node zurück, wie beim Erstellen des TreeWalker angegeben.

TreeWalker.whatToShow Schreibgeschützt

Gibt ein unsigned long zurück, das aus einer Bitmaske aus Konstanten besteht, die die Arten von Node beschreiben, die präsentiert werden müssen. Nicht übereinstimmende Knoten werden übersprungen, aber ihre Kinder können gegebenenfalls einbezogen werden. Die möglichen Werte sind:

Konstante	Numerischer Wert	Beschreibung
`NodeFilter.SHOW_ALL`	`4294967295` (das ist der Maximalwert von `unsigned long`)	Zeigt alle Knoten an.
`NodeFilter.SHOW_ATTRIBUTE` Veraltet	`2`	Zeigt Attribut-`Attr`-Knoten an. Dies ist nur sinnvoll, wenn ein `TreeWalker` mit einem `Attr`-Knoten als Wurzel erstellt wird. In diesem Fall bedeutet es, dass der Attributknoten in der ersten Position der Iteration oder Durchquerung erscheint. Da Attribute niemals Kinder anderer Knoten sind, erscheinen sie nicht, wenn über den Dokumentbaum traversiert wird.
`NodeFilter.SHOW_CDATA_SECTION` Veraltet	`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` Veraltet	`32`	Veraltet, nicht mehr nutzbar.
`NodeFilter.SHOW_ENTITY_REFERENCE` Veraltet	`16`	Veraltet, nicht mehr nutzbar.
`NodeFilter.SHOW_NOTATION` Veraltet	`2048`	Veraltet, nicht mehr nutzbar.
`NodeFilter.SHOW_PROCESSING_INSTRUCTION`	`64`	Zeigt `ProcessingInstruction`-Knoten an.
`NodeFilter.SHOW_TEXT`	`4`	Zeigt `Text`-Knoten an.

TreeWalker.filter Schreibgeschützt

Gibt den NodeFilter zurück, der mit diesem TreeWalker assoziiert ist, um die relevanten Knoten auszuwählen.

TreeWalker.currentNode

Ist der Node, auf den der TreeWalker derzeit zeigt.

Instanz-Methoden

Diese Schnittstelle erbt keine Methoden.

Hinweis: Im Kontext eines TreeWalker ist ein Knoten sichtbar, wenn er in der logischen Ansicht existiert, die durch die Argumenteparameter whatToShow und filter bestimmt wird. (Ob der Knoten auf dem Bildschirm sichtbar ist, ist irrelevant.)

TreeWalker.parentNode()

Bewegt den aktuellen Node zur ersten sichtbaren Vorfahrenknoten in der Dokumentreihenfolge und gibt den gefundenen Knoten zurück. Es bewegt ebenfalls den aktuellen Knoten zu diesem. Wenn ein solcher Knoten nicht existiert oder wenn er vor dem bei der Objekterstellung definierten Wurzelknoten liegt, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert.

TreeWalker.firstChild()

Bewegt den aktuellen Node zum ersten sichtbaren Kind des aktuellen Knotens und gibt das gefundene Kind zurück. Es bewegt ebenfalls den aktuellen Knoten zu diesem Kind. Wenn ein solches Kind nicht existiert, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert. Beachten Sie, dass der von firstChild() zurückgegebene Knoten von dem während der Instanziierung des TreeWalker-Objekts festgelegten Wert von whatToShow abhängt. Angenommen, der folgende HTML-Baum und wenn Sie whatToShow auf NodeFilter.SHOW_ALL setzen, gibt ein Aufruf von firstChild() einen Text-Knoten und kein HTMLDivElement-Objekt zurück.

html

<!doctype html>
<html lang="en">
  <head>
    <title>Demo</title>
  </head>
  <body>
    <div id="container"></div>
  </body>
</html>

let walker = document.createTreeWalker(document.body, NodeFilter.SHOW_ALL);
let node = walker.firstChild(); // nodeName: "#text"

Aber wenn wir das tun:

let walker = document.createTreeWalker(
  document.body,
  NodeFilter.SHOW_ELEMENT,
);
let node = walker.firstChild(); // nodeName: "DIV"

Das Gleiche gilt für nextSibling(), previousSibling(), firstChild() und lastChild()

TreeWalker.lastChild()

Bewegt den aktuellen Node zum letzten sichtbaren Kind des aktuellen Knotens und gibt das gefundene Kind zurück. Es bewegt ebenfalls den aktuellen Knoten zu diesem Kind. Wenn ein solches Kind nicht existiert, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert.

TreeWalker.previousSibling()

Bewegt den aktuellen Node zu seinem vorhergehenden Geschwister, falls vorhanden, und gibt das gefundene Geschwister zurück. Wenn ein solcher Knoten nicht existiert, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert.

TreeWalker.nextSibling()

Bewegt den aktuellen Node zu seinem nächsten Geschwister, falls vorhanden, und gibt das gefundene Geschwister zurück. Wenn ein solcher Knoten nicht existiert, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert.

TreeWalker.previousNode()

Bewegt den aktuellen Node zum vorhergehenden sichtbaren Knoten in der Dokumentreihenfolge und gibt den gefundenen Knoten zurück. Es bewegt ebenfalls den aktuellen Knoten zu diesem. Wenn ein solcher Knoten nicht existiert oder wenn er vor dem bei der Objekterstellung definierten Wurzelknoten liegt, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert.

TreeWalker.nextNode()

Bewegt den aktuellen Node zum nächsten sichtbaren Knoten in der Dokumentreihenfolge und gibt den gefundenen Knoten zurück. Es bewegt ebenfalls den aktuellen Knoten zu diesem. Wenn ein solcher Knoten nicht existiert, wird null zurückgegeben und der aktuelle Knoten wird nicht geändert.

Spezifikationen

Specification
DOM # interface-treewalker

Browser-Kompatibilität

Siehe auch

Die Erzeugermethode: Document.createTreeWalker().
Verwandte Schnittstelle: NodeIterator.

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden