TreeWalker
DOM
DOM
The TreeWalker object represents the nodes of a document subtree and a position within them.
A TreeWalker can be created using the Document.createTreeWalker() method.
Instance properties
This interface doesn't inherit any property.
- TreeWalker.root
- : Returns the root Node as specified when the
TreeWalkerwas created. - TreeWalker.whatToShow
- : Returns an
unsigned longwhich is a bitmask made of constants describing the types of Node that must be presented. Non-matching nodes are skipped, but their children may be included, if relevant. - TreeWalker.filter
- : Returns the
NodeFilterassociated with thisTreeWalkerused to select the relevant nodes. - TreeWalker.currentNode
- : Is the Node on which the
TreeWalkeris currently pointing at.
Instance methods
This interface doesn't inherit any method.
[!NOTE] In the context of a
TreeWalker, a node is visible if it exists in the logical view determined by thewhatToShowandfilterparameter arguments. (Whether or not the node is visible on the screen is irrelevant.)
- TreeWalker.parentNode()
- : Moves the current Node to the first visible ancestor node in the document order, and returns the found node. It also moves the current node to this one. If no such node exists, or if it is before that the root node defined at the object construction, returns
nulland the current node is not changed. - TreeWalker.firstChild()
-
: Moves the current Node to the first visible child of the current node, and returns the found child. It also moves the current node to this child. If no such child exists, returns
nulland the current node is not changed. Note that the node returned byfirstChild()is dependent on the value ofwhatToShowset during instantiation of theTreeWalkerobject. Assuming the following HTML tree, and if you set thewhatToShowtoNodeFilter.SHOW_ALLa call tofirstChild()will return aTextnode and not anHTMLDivElementobject.html <!doctype html> <html lang="en"> <head> <title>Demo</title> </head> <body> <div id="container"></div> </body> </html>js let walker = document.createTreeWalker(document.body, NodeFilter.SHOW_ALL); let node = walker.firstChild(); // nodeName: "#text"But if we do:
js let walker = document.createTreeWalker( document.body, NodeFilter.SHOW_ELEMENT, ); let node = walker.firstChild(); // nodeName: "DIV"The same applies to
nextSibling(),previousSibling(),firstChild()andlastChild() -
TreeWalker.lastChild()
- : Moves the current Node to the last visible child of the current node, and returns the found child. It also moves the current node to this child. If no such child exists,
nullis returned and the current node is not changed. - TreeWalker.previousSibling()
- : Moves the current Node to its previous sibling, if any, and returns the found sibling. If there is no such node, return
nulland the current node is not changed. - TreeWalker.nextSibling()
- : Moves the current Node to its next sibling, if any, and returns the found sibling. If there is no such node,
nullis returned and the current node is not changed. - TreeWalker.previousNode()
- : Moves the current Node to the previous visible node in the document order, and returns the found node. It also moves the current node to this one. If no such node exists, or if it is before that the root node defined at the object construction, returns
nulland the current node is not changed. - TreeWalker.nextNode()
- : Moves the current Node to the next visible node in the document order, and returns the found node. It also moves the current node to this one. If no such node exists, returns
nulland the current node is not changed.
Specifications
Browser compatibility
See also
- The creator method: Document.createTreeWalker().
- Related interface: NodeIterator.