NodeIterator.filter

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

var 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.	Recommendation	Initial definition.

Browser compatibility

See also

• The interface this property belongs to: NodeIterator.