TreeWalker.filter

The TreeWalker.filter read-only property returns a NodeFilter that is the filtering object associated with the TreeWalker.

When creating the TreeWalker, the filter object is passed in as the third parameter, and its method NodeFilter.acceptNode() is called on every single node to determine whether or not to accept it.

Syntax

nodeFilter = treeWalker.filter;

Example

var treeWalker = document.createTreeWalker(
    document.body,
    NodeFilter.SHOW_ELEMENT,
    { acceptNode: function(node) { return NodeFilter.FILTER_ACCEPT; } },
    false
);
nodeFilter = treeWalker.filter; // document.body in this case

Specifications

Specification Status Comment
DOM
The definition of 'TreeWalker.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 'TreeWalker.filter' in that specification.
Obsolete Initial definition.

Browser compatibility

BCD tables only load in the browser

See also