- Source:
Members
columnIndex :number
Optional property indicating the index of the column this FilterDescriptor describes how to filter. If this property
is not a positive number, it will be assumed this FilterDescriptor describes how to filter entire rows.
Type:
- number
- Source:
Methods
include(item) → {boolean}
Callback function to determine whether the given row or cell's parent row should be filtered. If FilterDescriptor#columnIndex
is defined, and a postiive number, the HTMLTableCellElement in the approprite position within the row being considered will be passed
to this function corresponding to this FilterDescriptor's FilterDescriptor#columnIndex property, otherwise the HTMLTableRowElement
being considered will be passed directly.
If this function returns false, the relevant row will be filtered.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
HTMLCellElement | HTMLTableRowElement | Cell or Row to be considered for inclusion. |
- Source:
Returns:
false if the given item should be filtered.
- Type
- boolean