Represents a row filter base that supports row filters for filtering rows in a sheet.
Syntax
var instance = new GcSpread.Sheets.RowFilterBase(range);
function RowFilterBase;
Inheritance Hierarchy
Object
GcSpread.Sheets.RowFilterBase
GcSpread.Sheets.HideRowFilter
Constructors
| Name | Description | |
|---|---|---|
 | RowFilterBase Constructor | Represents a row filter base that supports row filters for filtering rows in a sheet. |
Fields
| Name | Description | |
|---|---|---|
 | range | Gets or sets the range for the row filter. |
| typeName | Represents the type name string used for supporting serialization. |
Methods
| Name | Description | |
|---|---|---|
 | addAverageFilter | Adds the average filter for the row filter. |
| addBackgroundFilter | Adds the background filter for the row filter. |
| addDateFilter | Adds the date filter for the row filter. |
| addFilterItem | Adds a specified filter to the row filter. |
| addForegroundFilter | Adds the foreground filter for the row filter. |
| addNumberFilter | Adds the number filter for the row filter. |
| addTextFilter | Adds the text filter for the row filter. |
| addTop10Filter | Adds the top 10 filter for the row filter. |
| filter | Filters the specified column. |
| filterButtonVisible | Gets or sets whether the sheet column's filter button is displayed. |
| fromJSON | Loads the object state from the specified JSON string. |
| getFilteredItems | Gets all the filtered conditions. |
| getFilterItems | Gets the filters for the specified column. |
| getSortState | Gets the current sort state. |
| isColumnFiltered | Determines whether the specified column is filtered. |
| isFiltered | Gets a value that indicates whether any row is filtered. |
| isHideRowFilter | Determines whether the filter is HideRowFilter. |
| isRowFilteredOut | Determines whether the specified row is filtered out. |
| onFilter | Performs the action when some columns have just been filtered or unfiltered. |
| openFilterDialog | Opens the filter dialog when the user clicks the filter button. |
| reFilter | Refreshes all the filters. |
| removeFilterItems | Removes the specified filter. |
| reset | Clears all filters. |
| sortColumn | Sorts the specified column in the specified order. |
| toJSON | Saves the object state to a JSON string. |
| unfilter | Removes the filter from the specified column. |
See Also