The NodeIterator.whatToShow read-only property represents an unsigned integer representing a bitmask signifying what types of nodes should be returned by the NodeIterator.
Syntax
var nodeTypes = nodeIterator.whatToShow;
The values that can be combined to form the bitmask 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 or TreeWalker 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 or TreeWalker 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 or TreeWalker 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. |
Example
var nodeIterator = document.createNodeIterator(
document.body,
NodeFilter.SHOW_ELEMENT + NodeFilter.SHOW_COMMENT + NodeFilter.SHOW_TEXT,
{ acceptNode: function(node) { return NodeFilter.FILTER_ACCEPT; } },
false
);
if( (nodeIterator.whatToShow == NodeFilter.SHOW_ALL) ||
(nodeIterator.whatToShow % (NodeFilter.SHOW_COMMENT*2)) >= NodeFilter.SHOW_COMMENT) {
// nodeIterator will show comments
}
Specifications
| Specification | Status | Comment |
|---|---|---|
| DOM The definition of 'NodeIterator.whatToShow' in that specification. |
Living Standard | No change from Document Object Model (DOM) Level 2 Traversal and Range Specification. |
| Document Object Model (DOM) Level 2 Traversal and Range Specification The definition of 'NodeIterator.whatToShow' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
| 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 |
See also
- The interface this property belongs to:
NodeIterator.
Document Tags and Contributors
Tags:
Contributors to this page:
abbycar,
jamesbascle,
jwhitlock,
fscholz,
kollishivagangadhar,
Kartik_Chadha,
teoli,
Sheppy,
Jürgen Jeka
Last updated by:
abbycar,