{{APIRef("DOM")}}
The NodeIterator
interface represents an iterator over the members of a list of the nodes in a subtree of the DOM. The nodes will be returned in document order.
A NodeIterator
can be created using the {{domxref("Document.createNodeIterator()")}} method, as follows:
var nodeIterator = document.createNodeIterator(root, whatToShow, filter);
Properties
This interface doesn't inherit any property.
- {{domxref("NodeIterator.root")}} {{readonlyInline}}
- Returns a {{domxref("Node")}} representing the root node as specified when the
NodeIterator
was created. - {{domxref("NodeIterator.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. NodeFilter.SHOW_ATTRIBUTE
{{obsolete_inline}}2
Shows attribute {{ domxref("Attr") }} nodes. This is meaningful only when creating a {{ domxref("NodeIterator") }} 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. NodeFilter.SHOW_CDATA_SECTION
{{obsolete_inline}}8
Shows {{ domxref("CDATASection") }} nodes. NodeFilter.SHOW_COMMENT
128
Shows {{ domxref("Comment") }} nodes. NodeFilter.SHOW_DOCUMENT
256
Shows {{ domxref("Document") }} nodes. NodeFilter.SHOW_DOCUMENT_FRAGMENT
1024
Shows {{ domxref("DocumentFragment") }} nodes. NodeFilter.SHOW_DOCUMENT_TYPE
512
Shows {{ domxref("DocumentType") }} nodes. NodeFilter.SHOW_ELEMENT
1
Shows {{ domxref("Element") }} nodes. NodeFilter.SHOW_ENTITY
{{obsolete_inline}}32
Shows {{ domxref("Entity") }} nodes. This is meaningful only when creating a {{ domxref("NodeIterator") }} 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. NodeFilter.SHOW_ENTITY_REFERENCE
{{obsolete_inline}}16
Shows {{ domxref("EntityReference") }} nodes. NodeFilter.SHOW_NOTATION
{{obsolete_inline}}2048
Shows {{ domxref("Notation") }} nodes. This is meaningful only when creating a {{ domxref("NodeIterator") }} 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_INSTRUCTION
64
Shows {{ domxref("ProcessingInstruction") }} nodes. NodeFilter.SHOW_TEXT
4
Shows {{ domxref("Text") }} nodes. - {{domxref("NodeIterator.filter")}} {{readonlyInline}}
- Returns a {{domxref("NodeFilter")}} used to select the relevant nodes.
- {{domxref("NodeIterator.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("NodeIterator.referenceNode")}} {{readonlyInline}} {{experimental_inline() }}
- Returns the {{domxref("Node")}} to which the iterator is anchored.
- {{domxref("NodeIterator.pointerBeforeReferenceNode")}} {{readonlyInline}} {{ experimental_inline() }}
- Returns a {{domxref("Boolean")}} flag that indicates whether the {{domxref("NodeIterator")}} is anchored before, the flag being
true
, or after, the flag beingfalse
, the anchor node.
Methods
This interface doesn't inherit any method.
- {{domxref("NodeIterator.detach()")}} {{obsolete_inline()}}
- This operation is a no-op. It doesn't do anything. Previously it was telling the engine that the
NodeIterator
was no more used, but this is now useless. - {{domxref("NodeIterator.previousNode()")}}
- Returns the previous {{domxref("Node")}} in the document, or
null
if there are none. - {{domxref("NodeIterator.nextNode()")}}
- Returns the next {{domxref("Node")}} in the document, or
null
if there are none.
Specifications
Specification | Status | Comment |
---|---|---|
{{SpecName('DOM WHATWG', '#nodeiterator', 'NodeIterator')}} | {{Spec2('DOM WHATWG')}} | Added the referenceNode and pointerBeforeReferenceNode properties.Removed the expandEntityReferences property.The method detach() has been changed to be a no-op.The methods previousNode() and nextNode() don't raise an exception any more. |
{{SpecName('DOM2 Traversal_Range', 'traversal.html#Iterator-overview', 'NodeIterator')}} | {{Spec2('DOM2 Traversal_Range')}} | Initial definition. |
Browser compatibility
{{CompatibilityTable}}
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 1.0 | {{CompatGeckoDesktop("1.9.1")}} | 9.0 | 9.0 | 3.0 |
Feature | Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{CompatGeckoMobile("1.9.1")}} | {{CompatVersionUnknown}} | 9.0 | 3.0 |
See also
- The creator method: {{domxref("Document.createNodeIterator()")}}.
- Related interfaces: {{domxref("NodeFilter")}}, {{domxref("TreeWalker")}}.