.filter()
Syntax Variants
Parameters
- list
- a list to filter. A list to use as input. Can be an array, a Minified list or any other array-like structure with length property.
- filterFunc
- The filter callback
function(item, index)
that decides which elements to include:- item
- The current list element.
- index
- The second the zero-based index of the current element.
- this
- The given context if not null. Otherwise the list.
- (callback return value)
- true to include the item in the new list, false to omit it.
- ctx (optional)
- a context to pass to the callback as 'this'. Only supported in UTIL module.
- value
- a value to remove from the list. It will be determined which elements to remove using
==
. Must not be a function. Requires Util module. - (return value)
- the new, filtered list
Description
Creates a new Minified list by taking an existing list and omitting certain elements from it. You can either specify a callback function to approve those items that will be in the new list (all modules), or you can pass a value to remove from the new list (Util module only).
If the callback function returns true, the item is shallow-copied in the new list, otherwise it will be removed.
For values, a simple equality operation (==
) will be used.
Example
Removing all instances of the number 10 from a list:
var list = _([4, 10, 22, 7, 2, 19, 10]).filter(10);
Example
Removing all numbers over 10 from a list:
var list = _([4, 22, 7, 2, 19]).filter(function(item, index) { return item <= 10; });
Example
The previous example with a native array is input. Note that the result is always a Minified list:
var list = _.filter([4, 22, 7, 2, 19], function(item, index) { return item <= 10; });
Example
Creates a list of all unchecked checkboxes on a web page:
var list = $('input').filter(function(item, index) { return item.getAttribute('type') == 'checkbox' && item.checked; });
See also..
only()
offers selector-based filtering.
Comments
comments powered by DisqusFunctions
- $() Web
- list.length Web, Util
- $$() Web
- $.getCookie()
- $.loop() Web
- $.off() Web
- $.parseJSON() Web
- $.ready() Web
- $.request() Web
- $.setCookie()
- $.toJSON() Web
- $.wait()
- .add() Web
- .addAfter() Web
- .addBefore() Web
- .addFront() Web
- .animate() Web
- .array() Util
- .call() Util
- .clone() Web
- .collect() Web, Util
- .contains() Util
- .dial() Web
- .each() Web, Util
- .endsWith() Util
- .equals() Util
- .fill() Web
- .filter() Web, Util
- .find() Web, Util
- .findLast() Web, Util
- .get() Web
- .hide() Web
- .ht()
- .intersection() Util
- .is() Web
- .join() Util
- .map() Util
- .merge() Util
- .next() Web
- .not() Web
- .offset()
- .on() Web
- .onChange() Web
- .onClick() Web
- .onFocus() Web
- .onOver() Web
- .only()
- .per() Util
- .reduce() Util
- .remove() Web
- .replace() Web
- .reverse() Util
- .select() Web
- .set() Web
- .show() Web
- .sort() Util
- .startsWith() Util
- .sub() Web, Util
- .text() Web
- .toObject() Util
- .toggle() Web
- .trav() Web
- .trigger() Web
- .uniq() Util
- .unite() Util
- .up() Web
- .values() Web
- EE() Web
- HTML() Web
- M Web, Util
- MINI.getter Web
- MINI.setter Web
- Minified Lists Web, Util
- Promise Web, Util
- _() Util
- _.bind() Util
- _.copyObj() Util
- _.dateAdd() Util
- _.dateClone() Util
- _.dateDiff() Util
- _.dateMidnight() Util
- _.eachObj() Util
- _.escapeHtml() Util
- _.escapeRegExp() Util
- _.extend() Util
- _.filterObj() Util
- _.format() Util
- _.formatHtml() Util
- _.formatValue() Util
- _.isBool() Util
- _.isDate() Util
- _.isEmpty() Util
- _.isFunction() Util
- _.isList() Util
- _.isNumber() Util
- _.isObject() Util
- _.isString() Util
- _.isValue() Util
- _.keys() Util
- _.mapObj() Util
- _.pad() Util
- _.parseDate() Util
- _.parseNumber() Util
- _.partial() Util
- _.promise()
- _.range()
- _.template() Util
- _.toString() Util
- _.trim() Util
- _.values() Util
- define() Web, Util
- promise.always()
- promise.error() Web, Util
- promise.fire()
- promise.stop()
- promise.then() Web
- require() Web, Util
- How to...