TreeWalker
The TreeWalker object represents the nodes of a document subtree and a position within them.
Methods
firstChild()
firstChild(): Node | null;
The TreeWalker.firstChild() method moves the current Node to the first visible child of the current node, and returns the found child. If no such child exists, it returns null and the current node is not changed.
Returns
Node | null
lastChild()
lastChild(): Node | null;
The TreeWalker.lastChild() method moves the current Node to the last visible child of the current node, and returns the found child. If no such child exists, it returns null and the current node is not changed.
Returns
Node | null
nextNode()
nextNode(): Node | null;
The TreeWalker.nextNode() method moves the current Node to the next visible node in the document order, and returns the found node. If no such node exists, it returns null and the current node is not changed.
Returns
Node | null
nextSibling()
nextSibling(): Node | null;
The TreeWalker.nextSibling() method moves the current Node to its next sibling, if any, and returns the found sibling. If there is no such node, it returns null and the current node is not changed.
Returns
Node | null
parentNode()
parentNode(): Node | null;
The TreeWalker.parentNode() method moves the current Node to the first visible ancestor node in the document order, and returns the found node. If no such node exists, or if it is above the TreeWalker's root node, it returns null and the current node is not changed.
Returns
Node | null
previousNode()
previousNode(): Node | null;
The TreeWalker.previousNode() method moves the current Node to the previous visible node in the document order, and returns the found node. If no such node exists, or if it is before that the root node defined at the object construction, it returns null and the current node is not changed.
Returns
Node | null
previousSibling()
previousSibling(): Node | null;
The TreeWalker.previousSibling() method moves the current Node to its previous sibling, if any, and returns the found sibling. If there is no such node, it returns null and the current node is not changed.
Returns
Node | null
Properties
currentNode
currentNode: Node;
The TreeWalker.currentNode property represents the Node which the TreeWalker is currently pointing at.
filter
readonly filter: NodeFilter | null;
The TreeWalker.filter read-only property returns the NodeFilter associated with the TreeWalker.
root
readonly root: Node;
The TreeWalker.root read-only property returns the root Node that the TreeWalker traverses.
whatToShow
readonly whatToShow: number;
The TreeWalker.whatToShow read-only property returns a bitmask that indicates the types of nodes to show. Non-matching nodes are skipped, but their children may be included, if relevant.