Mixin: API3.Filter

[No frames]

A filter interface which selects some elements from an entity collection.

The Filter object is never instantiated; it is only a template on what objects are used for filtering entities.

Source:

filter.js, line 14

Methods

func(ent) → {Boolean} The actual filter function to select entities.

Parameters:

ent : API3.Entity An entity to test whether it shall belong to a derived/filtered collection.

Source:

filter.js, line 32

Returns:

true iff the tested entity currently matches the filter criterion and shall be included in the derived collection.

Type: Boolean