Class $.wijmo.wijspread.RowFilterBase
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
$.wijmo.wijspread.RowFilterBase(sheet, range)
Creates a new row filter.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Gets or sets the range for the row filter.
|
|
|
The filtered worksheet.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addAverageFilter(col, compareType)
Adds the average filter for the row filter.
|
|
|
addBackgroundFilter(col, color)
Adds the background filter for the row filter.
|
|
|
addDateFilter(col, compareType, date)
Adds the date filter for the row filter.
|
|
|
addFilterItem(col, filterItem)
Adds a specified filter to the row filter.
|
|
|
addForegroundFilter(col, color)
Adds the foreground filter for the row filter.
|
|
|
addNumberFilter(col, compareType, number)
Adds the number filter for the row filter.
|
|
|
addTextFilter(col, compareType, text)
Adds the text filter for the row filter.
|
|
|
addTop10Filter(col, compareType, rank)
Adds the top 10 filter for the row filter.
|
|
|
filter(col)
Filters the specified column.
|
|
|
Gets all the filtered conditions.
|
|
|
getFilterItems(col)
Gets the filters for a specified column.
|
|
|
Gets row filter's showFilterButton.
|
|
|
getSortState(col)
Gets the current sort state.
|
|
|
isColumnFiltered(col)
Determines whether a specified column is filtered.
|
|
|
Gets a value that indicates whether any row is filtered.
|
|
|
Determines whether the filter is HideRowFilter.
|
|
|
isRowFilteredOut(row)
Determines whether the specified row is filtered out.
|
|
|
reFilter()
Refreshes all the filters.
|
|
|
removeFilterItems(col)
Removes the specified filter.
|
|
|
reset()
Clears all filters.
|
|
|
setShowFilterButton(direction)
Sets row filter's showFilterButton.
|
|
|
sortColumn(col, ascending)
Sorts the specified column in the specified order.
|
|
|
unfilter(col)
Removes the filter from the specified column.
|
Class Detail
$.wijmo.wijspread.RowFilterBase(sheet, range)
Creates a new row filter.
- Parameters:
- {function} sheet
- The sheet to filter.
- {function} range
- The filter range.
Field Detail
range
Gets or sets the range for the row filter.
Type: GrapeCity.UI.Range
sheet
The filtered worksheet.
Type: UI.Sheet
Method Detail
addAverageFilter(col, compareType)
Adds the average filter for the row filter.
- Parameters:
- col
- The column index.
- compareType
- The comparison type.
addBackgroundFilter(col, color)
Adds the background filter for the row filter.
- Parameters:
- col
- The column index.
- color
- The background color for comparison.
addDateFilter(col, compareType, date)
Adds the date filter for the row filter.
- Parameters:
- col
- The column index.
- compareType
- The date comparison type.
- date
- The date for comparison.
addFilterItem(col, filterItem)
Adds a specified filter to the row filter.
- Parameters:
- col
- The column index.
- filterItem
- The filter.
addForegroundFilter(col, color)
Adds the foreground filter for the row filter.
- Parameters:
- col
- The column index.
- color
- The foreground color for comparison.
addNumberFilter(col, compareType, number)
Adds the number filter for the row filter.
- Parameters:
- col
- The column index.
- compareType
- The comparison type.
- number
- The number for comparison.
addTextFilter(col, compareType, text)
Adds the text filter for the row filter.
- Parameters:
- col
- The column index.
- compareType
- The text comparison type.
- text
- The text for comparison.
addTop10Filter(col, compareType, rank)
Adds the top 10 filter for the row filter.
- Parameters:
- col
- The column index.
- compareType
- The comparison type.
- rank
- The item count of the top 10 condition.
filter(col)
Filters the specified column.
- Parameters:
- col
- The column index.
getFilteredItems()
Gets all the filtered conditions.
- Returns:
- Returns a collection that contains all the filtered conditions.
getFilterItems(col)
Gets the filters for a specified column.
- Parameters:
- col
- Returns:
- Returns a collection that contains filters that belong to a specified column.
{boolean}
getShowFilterButton()
Gets row filter's showFilterButton.
- Returns:
- {boolean} The row filter's showFilterButton.
{GrapeCity.$.wijmo.wijspread.SortState}
getSortState(col)
Gets the current sort state.
- Parameters:
- col
- Returns:
- {GrapeCity.$.wijmo.wijspread.SortState} The sort state of the current filter.
{boolean}
isColumnFiltered(col)
Determines whether a specified column is filtered.
- Parameters:
- col
- The column index.
- Returns:
- {boolean} true if the column is filtered; otherwise, false.
{boolean}
isFiltered()
Gets a value that indicates whether any row is filtered.
- Returns:
- {boolean} true if some rows are filtered; otherwise, false.
{boolean}
isHideRowFilter()
Determines whether the filter is HideRowFilter.
- Returns:
- {boolean} true if the filter is HideRowFilter; otherwise, false.
{boolean}
isRowFilteredOut(row)
Determines whether the specified row is filtered out.
- Parameters:
- row
- The row index.
- Returns:
- {boolean} true if the row is filtered out; otherwise, false.
reFilter()
Refreshes all the filters.
removeFilterItems(col)
Removes the specified filter.
- Parameters:
- col
- The column index.
reset()
Clears all filters.
setShowFilterButton(direction)
Sets row filter's showFilterButton.
- Parameters:
- {boolean} direction
- The row filter's showFilterButton.
{boolean}
sortColumn(col, ascending)
Sorts the specified column in the specified order.
- Parameters:
- {number} col
- The column index.
- {boolean} ascending
- Set to true to sort as ascending.
- Returns:
- {boolean} true if sorted successfully; otherwise, false.
unfilter(col)
Removes the filter from the specified column.
- Parameters:
- col
- The column index.