NodeIterator
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.
Syntax
A NodeIterator
can be created using the
Document.createNodeIterator()
method, as follows:
js
const nodeIterator = document.createNodeIterator(root, whatToShow, filter);
Instance properties
This interface doesn't inherit any property.
NodeIterator.root
Read only-
Returns a
Node
representing the root node as specified when theNodeIterator
was created. NodeIterator.whatToShow
Read only-
Returns an
unsigned long
being a bitmask made of constants describing the types ofNode
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
4294967295
(that is the max value ofunsigned long
)Shows all nodes. NodeFilter.SHOW_ATTRIBUTE
Deprecated2
Shows attribute Attr
nodes. This is meaningful only when creating aNodeIterator
with anAttr
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
Deprecated8
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
Deprecated32
Legacy, no more used. NodeFilter.SHOW_ENTITY_REFERENCE
Deprecated16
Legacy, no more used. NodeFilter.SHOW_NOTATION
Deprecated2048
Legacy, no more used. NodeFilter.SHOW_PROCESSING_INSTRUCTION
64
Shows ProcessingInstruction
nodes.NodeFilter.SHOW_TEXT
4
Shows Text
nodes. NodeIterator.filter
Read only-
Returns a
NodeFilter
used to select the relevant nodes. -
NodeIterator.referenceNode
Read only Experimental -
Returns the
Node
to which the iterator is anchored. NodeIterator.pointerBeforeReferenceNode
Read only Experimental-
Returns a boolean flag that indicates whether the
NodeIterator
is anchored before, the flag beingtrue
, or after, the flag beingfalse
, the anchor node.
Instance methods
This interface doesn't inherit any method.
NodeIterator.detach()
Deprecated-
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. NodeIterator.previousNode()
-
Returns the previous
Node
in the document, ornull
if there are none. NodeIterator.nextNode()
-
Returns the next
Node
in the document, ornull
if there are none.
Specifications
Specification |
---|
DOM Standard # interface-nodeiterator |
Browser compatibility
BCD tables only load in the browser
See also
- The creator method:
Document.createNodeIterator()
. - Related interfaces: