Class: FFilter
This interface class provides methods to modify the filter settings of a worksheet.
Methods
getColumnFilterCriteria()
getColumnFilterCriteria(col): any
Get the filter criteria of a column.
Parameters
Parameter | Type | Description |
---|---|---|
col | number | The column number. |
Returns
any
The filter criteria of the column.
getFilteredOutRows()
getFilteredOutRows(): number[]
Get the filtered out rows by this filter.
Returns
number
[]
Filtered out rows by this filter.
getRange()
getRange(): FRange
Get the range of the filter.
Returns
The range of the filter.
remove()
remove(): boolean
Remove the filter from the worksheet.
Returns
boolean
If the filter is removed.
removeColumnFilterCriteria()
removeColumnFilterCriteria(col): FFilter
Clear the filter criteria of a column.
Parameters
Parameter | Type | Description |
---|---|---|
col | number | The column number. |
Returns
The interface class to handle the filter.
removeFilterCriteria()
removeFilterCriteria(): FFilter
Remove the filter criteria of all columns.
Returns
If the filter criteria is removed.
setColumnFilterCriteria()
setColumnFilterCriteria(col, criteria): FFilter
Set the filter criteria of a column.
Parameters
Parameter | Type | Description |
---|---|---|
col | number | The column number. |
criteria | ISetSheetsFilterCriteriaCommandParams | The new filter criteria. |
Returns
The interface class to handle the filter.