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 Document.createNodeIterator()
method, as follows:
var nodeIterator = document.createNodeIterator(root, whatToShow, filter);
This interface doesn't inherit any property.
NodeIterator.root
Read only
Node
representing the root node as specified when the NodeIterator
was created.NodeIterator.whatToShow
Read only
unsigned long
being a bitmask made of constants describing the types of 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 of unsigned long ) | Shows all nodes. |
NodeFilter.SHOW_ATTRIBUTE
| 2 | Shows attribute Attr nodes. This is meaningful only when creating a NodeIterator with an 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
| 8 | Shows CDATASection nodes. |
NodeFilter.SHOW_COMMENT | 128 | Shows Comment nodes. |
NodeFilter.SHOW_DOCUMENT | 256 | Shows Document nodes. |
NodeFilter.SHOW_DOCUMENT_FRAGMENT | 1024 | Shows DocumentFragment nodes. |
NodeFilter.SHOW_DOCUMENT_TYPE | 512 | Shows DocumentType nodes. |
NodeFilter.SHOW_ELEMENT | 1 | Shows Element nodes. |
NodeFilter.SHOW_ENTITY
| 32 | Shows Entity nodes. This is meaningful only when creating a NodeIterator with an Entity node as its root; in this case, it means that the 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
| 16 | Shows EntityReference nodes. |
NodeFilter.SHOW_NOTATION
| 2048 | Shows Notation nodes. This is meaningful only when creating a NodeIterator with a Notation node as its root; in this case, it means that the 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 ProcessingInstruction nodes. |
NodeFilter.SHOW_TEXT | 4 | Shows Text nodes. |
NodeIterator.filter
Read only
NodeFilter
used to select the relevant nodes.NodeIterator.expandEntityReferences
Read only
Boolean
indicating if, when discarding an EntityReference
its whole sub-tree must be discarded at the same time.NodeIterator.referenceNode
Read only
Node
to which the iterator is anchored.NodeIterator.pointerBeforeReferenceNode
Read only
Boolean
flag that indicates whether the NodeIterator
is anchored before, the flag being true
, or after, the flag being false
, the anchor node.This interface doesn't inherit any method.
NodeIterator.detach()
NodeIterator
was no more used, but this is now useless.NodeIterator.previousNode()
Node
in the document, or null
if there are none.NodeIterator.nextNode()
Node
in the document, or null
if there are none.Specification | Status | Comment |
---|---|---|
DOM The definition of 'NodeIterator' in that specification. | Living Standard | 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. |
Document Object Model (DOM) Level 2 Traversal and Range Specification The definition of 'NodeIterator' in that specification. | Recommendation | Initial definition. |
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | 1.0 | (Yes) | 3.5 (1.9.1) | 9.0 | 9.0 | 3.0 |
Feature | Android | Edge | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | (Yes) | (Yes) | 1.0 (1.9.1) | (Yes) | 9.0 | 3.0 |
Document.createNodeIterator()
.NodeFilter
, TreeWalker
.
© 2005–2017 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/NodeIterator