Access filter criteria. To create a new criteria, use SpreadsheetApp.newFilterCriteria() and FilterCriteriaBuilder.
Methods
| Method | Return type | Brief description |
|---|---|---|
copy() | FilterCriteriaBuilder | Creates a builder for a filter criteria based on this filter criteria's settings. |
getCriteriaType() | BooleanCriteria | Returns the boolean criteria type as defined in the BooleanCriteria enum. |
getCriteriaValues() | Object[] | Returns an array of arguments for the boolean criteria. |
getHiddenValues() | String[] | Returns the values to hide. |
getVisibleBackgroundColor() | Color | Returns the background color used as a filter criteria. |
getVisibleForegroundColor() | Color | Returns the foreground color used as a filter criteria. |
getVisibleValues() | String[] | Returns the values to show. |
Detailed documentation
copy()
Creates a builder for a filter criteria based on this filter criteria's settings.
Return
FilterCriteriaBuilder — a filter criteria builder based on this filter criteria
getCriteriaType()
Returns the boolean criteria type as defined in the BooleanCriteria enum. To get the
arguments for the criteria, use getCriteriaValues(). To use these values to create or
modify a filter criteria, see FilterCriteriaBuilder.withCriteria(criteria, args).
Return
BooleanCriteria — the type of boolean criteria
getCriteriaValues()
Returns an array of arguments for the boolean criteria. To get the boolean criteria type, use
getCriteriaType(). To use these values to create or modify a filter criteria, see FilterCriteriaBuilder.withCriteria(criteria, args).
Return
Object[] — an array of arguments appropriate to the boolean criteria type; the number of arguments
and their type match the corresponding when...() method of the FilterCriteriaBuilder class
getHiddenValues()
Returns the values to hide.
Return
String[] — an array of values to hide
getVisibleBackgroundColor()
Returns the background color used as a filter criteria. Cells with this background color remain visible.
Return
Color — The background color used as a filter criteria.
getVisibleForegroundColor()
Returns the foreground color used as a filter criteria. Cells with this foreground color remain visible.
Return
Color — The foreground color used as a filter criteria.
getVisibleValues()
Returns the values to show.
Return
String[] — an array of values to show