The NodeIterator.filter
read-only method returns a NodeFilter
object, that is an object implement an acceptNode(node)
method, used to screen nodes.
When creating the NodeIterator
, the filter object is passed in as the third parameter, and the object method acceptNode(node)
is called on every single node to determine whether or not to accept it. This function should return the constant NodeFilter.FILTER_ACCEPT
for cases when the node should be accepted and NodeFilter.FILTER_REJECT
for cases when the node should be rejected.
Syntax
nodeFilter = nodeIterator.filter;
Example
const nodeIterator = document.createNodeIterator( document.body, NodeFilter.SHOW_ELEMENT, { acceptNode: function(node) { return NodeFilter.FILTER_ACCEPT; } }, false ); nodeFilter = nodeIterator.filter;
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'NodeIterator.filter' 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.filter' in that specification. |
Obsolete | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
filter | Chrome Full support 1 | Edge Full support 12 | Firefox Full support 3.5 | IE Full support 9 | Opera Full support 9 | Safari Full support 3 | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support 4 | Opera Android Full support 10.1 | Safari iOS Full support 3 | Samsung Internet Android Full support Yes |
Legend
- Full support
- Full support
See also
- The interface this property belongs to:
NodeIterator
.