Document: createNodeIterator() method
DOM
DOM
The Document.createNodeIterator() method returns a new NodeIterator object.
Syntax
createNodeIterator(root)
createNodeIterator(root, whatToShow)
createNodeIterator(root, whatToShow, filter)
Parameters
root-
: The root node at which to begin the NodeIterator's traversal.
-
whatToShow -
: An optional
unsigned longrepresenting a bitmask created by combining the constant properties ofNodeFilter. It is a convenient way of filtering for certain types of node. It defaults to0xFFFFFFFFrepresenting theSHOW_ALLconstant.Constant Numerical value Description NodeFilter.SHOW_ALL0xFFFFFFFFShows all nodes. NodeFilter.SHOW_ATTRIBUTE0x2Shows Attr nodes. NodeFilter.SHOW_CDATA_SECTION0x8Shows CDATASection nodes. NodeFilter.SHOW_COMMENT0x80Shows Comment nodes. NodeFilter.SHOW_DOCUMENT0x100Shows Document nodes. NodeFilter.SHOW_DOCUMENT_FRAGMENT0x400Shows DocumentFragment nodes. NodeFilter.SHOW_DOCUMENT_TYPE0x200Shows DocumentType nodes. NodeFilter.SHOW_ELEMENT0x1Shows Element nodes. NodeFilter.SHOW_ENTITY0x20Legacy, no longer effective. NodeFilter.SHOW_ENTITY_REFERENCE0x10Legacy, no longer effective. NodeFilter.SHOW_NOTATION0x800Legacy, no longer effective. NodeFilter.SHOW_PROCESSING_INSTRUCTION0x40Shows ProcessingInstruction nodes. NodeFilter.SHOW_TEXT0x4Shows Text nodes. [!NOTE] The
NodeFilter.SHOW_ATTRIBUTEconstant is only effective when the root is an attribute node. Since the parent of anyAttrnode is alwaysnull, TreeWalker.nextNode() and TreeWalker.previousNode() will never return anAttrnode. To traverseAttrnodes, use Element.attributes instead. -
filter -
: A callback function or an object with an
acceptNode()method. The function or method will be called for each node in the subtree based at root which is accepted as included by the whatToShow flag to determine whether or not to include it in the list of iterable nodes. The method should return one ofNodeFilter.FILTER_ACCEPT,NodeFilter.FILTER_REJECT, orNodeFilter.FILTER_SKIP. See the Example.For
createNodeIterator, the valuesNodeFilter.FILTER_REJECTandNodeFilter.FILTER_SKIPare equivalent. This node will not be included in the list of iterable nodes, but its children will continue to be iterated over.
Return value
A new NodeIterator object.
Examples
const nodeIterator = document.createNodeIterator(
document.body,
NodeFilter.SHOW_ELEMENT,
(node) =>
node.nodeName.toLowerCase() === "p"
? NodeFilter.FILTER_ACCEPT
: NodeFilter.FILTER_REJECT,
);
const pars = [];
let currentNode;
while ((currentNode = nodeIterator.nextNode())) {
pars.push(currentNode);
}
The same, but using an object with an acceptNode() method:
const nodeIterator = document.createNodeIterator(
document.body,
NodeFilter.SHOW_ELEMENT,
{
acceptNode(node) {
return node.nodeName.toLowerCase() === "p"
? NodeFilter.FILTER_ACCEPT
: NodeFilter.FILTER_REJECT;
},
},
);
const pars = [];
let currentNode;
while ((currentNode = nodeIterator.nextNode())) {
pars.push(currentNode);
}