gridx.modules.filter.Filter
Object » _Module » gridx.modules.filter.Filter
dojo.require("gridx.modules.filter.Filter");
Defined in gridx/modules/filter/Filter.js
This module makes it possible for user to set arbitrary filter condition to grid.
Method Summary
- constructor()
- getAPIPath()
- getFilter() Return the current checker function. return: Function|null|undefined (or anything that is invalid) The current checker function
- setFilter(checker, skipUpdateBody) Apply function *checker* as the filter condition to filter every row.
- setupFilterQuery(obj)
Methods
Overrides _Module
Return the current checker function.
return: Function|null|undefined (or anything that is invalid)
The current checker function
Overrides _Module
Apply function *checker* as the filter condition to filter every row.
| Parameter | Type | Description |
|---|---|---|
| checker | Function|null | Function|null|undefined (or anything that is invalid) A function only returning TRUE or FALSE. It is used to decide whether a row should survive. If it is null (or anything invalid here), then clear the current filter. |
| skipUpdateBody | Boolean | Optional. Whether to immediately update grid UI after filtering.
return:
undefined
throw:
If *skipUpdateBody* is not TRUE, then must not throw, else, only allowed to throw the exceptions
that are generated from the *checker* function.
If *checker* is not a function, or null, should not throw. |