{{DomRef}}
The TreeWalker
object represents the nodes of a document subtree and a position within them.
A TreeWalker
can be created using the {{domxref("Document.createTreeWalker()")}} method.
Properties
This interface doesn't inherit any property.
- {{domxref("TreeWalker.root")}} {{readonlyInline}}
-
Returns a {{domxref("Node")}} representing the root node as specified when the
TreeWalker
was created. - {{domxref("TreeWalker.whatToShow")}} {{readonlyInline}}
-
Returns an
unsigned long
being a bitmask made of constants describing the types of {{domxref("Node")}} that must to be presented. Non-matching nodes are skipped, but their children may be included, if relevant. The possible values are:
Constant Numerical value Description NodeFilter.SHOW_ALL
-1
(that is the max value ofunsigned long
)Shows all nodes.
{{deprecated_inline}}NodeFilter.
SHOW_ATTRIBUTE2
Shows attribute {{ domxref("Attr") }} nodes. This is meaningful only when creating a {{ domxref("TreeWalker") }} with an {{ domxref("Attr") }} node as its root; in this case, it means that the attribute node will appear in the first position of the iteration or traversal. Since attributes are never children of other nodes, they do not appear when traversing over the document tree.
{{deprecated_inline}}NodeFilter.
SHOW_CDATA_SECTION8
Shows {{ domxref("CDATASection") }} nodes. NodeFilter.
SHOW_COMMENT128
Shows {{ domxref("Comment") }} nodes. NodeFilter.
SHOW_DOCUMENT256
Shows {{ domxref("Document") }} nodes. NodeFilter.
SHOW_DOCUMENT_FRAGMENT1024
Shows {{ domxref("DocumentFragment") }} nodes. NodeFilter.
SHOW_DOCUMENT_TYPE512
Shows {{ domxref("DocumentType") }} nodes. NodeFilter.
SHOW_ELEMENT1
Shows {{ domxref("Element") }} nodes.
{{deprecated_inline}}NodeFilter.
SHOW_ENTITY32
Shows {{ domxref("Entity") }} nodes. This is meaningful only when creating a {{ domxref("TreeWalker") }} with an {{ domxref("Entity") }} node as its root; in this case, it means that the {{ domxref("Entity") }} node will appear in the first position of the traversal. Since entities are not part of the document tree, they do not appear when traversing over the document tree.
{{deprecated_inline}}NodeFilter.
SHOW_ENTITY_REFERENCE16
Shows {{ domxref("EntityReference") }} nodes.
{{deprecated_inline}}
SHOW_NOTATIONNodeFilter.
2048
Shows {{ domxref("Notation") }} nodes. This is meaningful only when creating a {{ domxref("TreeWalker") }} with a {{ domxref("Notation") }} node as its root; in this case, it means that the {{ domxref("Notation") }} node will appear in the first position of the traversal. Since entities are not part of the document tree, they do not appear when traversing over the document tree. NodeFilter.
SHOW_PROCESSING_INSTRUCTION64
Shows {{ domxref("ProcessingInstruction") }} nodes. NodeFilter.
SHOW_TEXT4
Shows {{ domxref("Text") }} nodes. - {{domxref("TreeWalker.filter")}} {{readonlyInline}}
- Returns a {{domxref("NodeFilter")}} used to select the relevant nodes.
- {{domxref("TreeWalker.expandEntityReferences")}} {{readonlyInline}}{{deprecated_inline}}
- Is a {{domxref("Boolean")}} indicating if, when discarding an {{domxref("EntityReference")}} its whole sub-tree must be discarded at the same time.
- {{domxref("TreeWalker.currentNode")}}
-
Is the {{domxref("Node")}} on which the
TreeWalker
is currently pointing at.
Methods
This interface doesn't inherit any method.
- {{domxref("TreeWalker.parentNode()")}}
-
Moves the current {{domxref("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
null
and the current node is not changed. - {{domxref("TreeWalker.firstChild()")}}
-
Moves the current {{domxref("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
null
and the current node is not changed. - {{domxref("TreeWalker.lastChild()")}}
-
Moves the current {{domxref("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, returns
null
and the current node is not changed. - {{domxref("TreeWalker.previousSibling()")}}
-
Moves the current {{domxref("Node")}} to its previous sibling, if any, and returns the found sibling. I there is no such node, return
null
and the current node is not changed. - {{domxref("TreeWalker.nextSibling()")}}
-
Moves the current {{domxref("Node")}} to its next sibling, if any, and returns the found sibling. I there is no such node, return
null
and the current node is not changed. - {{domxref("TreeWalker.previousNode()")}}
-
Moves the current {{domxref("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,or if it is before that the root node defined at the object construction, returns
null
and the current node is not changed. - {{domxref("TreeWalker.nextNode()")}}
-
Moves the current {{domxref("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
null
and the current node is not changed.
Specifications
Specification | Status | Comment |
---|---|---|
{{SpecName('DOM WHATWG', '#treeWalker', 'NodeIterator')}} | {{Spec2('DOM WHATWG')}} | Removed the expandEntityReferences property. |
{{SpecName('DOM2 Traversal_Range', 'traversal.html#Traversal-TreeWalker', 'NodeIterator')}} | {{Spec2('DOM2 Traversal_Range')}} | Initial definition. |
Browser compatibility
{{CompatibilityTable}}
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 1.0 | {{CompatGeckoDesktop("1.8.1")}} | 9.0 | 9.0 | 3.0 |
Feature | Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{CompatGeckoMobile("1.8.1")}} | {{CompatVersionUnknown}} | 9.0 | 3.0 |
See also
- The creator method: {{domxref("Document.createTreeWalker()")}}.
- Related interfaces: {{domxref("NodeFilter")}}, {{domxref("NodeIterator")}}.