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

JavaScript
nodeFilter = treeWalker.filter;

Example

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

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support 1.0 2.0 (1.8.1) 9.0 9.0 3.0
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) 1.0 (1.8.1) (Yes) 9.0 3.0

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/treewalker/filter

API DOM Property TreeWalker