Builder for FilterCriteria
.
Methods
Method | Return type | Brief description |
---|---|---|
build() | FilterCriteria | Constructs a filter criteria from the settings supplied to the builder. |
copy() | FilterCriteriaBuilder | Copies this filter criteria and creates a criteria builder that you can apply to another filter. |
getCriteriaType() | BooleanCriteria | Returns the criteria's boolean type, for example, CELL_EMPTY . |
getCriteriaValues() | Object[] | Returns an array of arguments for boolean criteria. |
getHiddenValues() | String[] | Returns the values that the filter hides. |
getVisibleBackgroundColor() | Color | Returns the background color used as filter criteria. |
getVisibleForegroundColor() | Color | Returns the foreground color used as a filter criteria. |
getVisibleValues() | String[] | Returns the values that the pivot table filter shows. |
setHiddenValues(values) | FilterCriteriaBuilder | Sets the values to hide. |
setVisibleBackgroundColor(visibleBackgroundColor) | FilterCriteriaBuilder | Sets the background color used as a filter criteria. |
setVisibleForegroundColor(visibleForegroundColor) | FilterCriteriaBuilder | Sets the foreground color used as a filter criteria. |
setVisibleValues(values) | FilterCriteriaBuilder | Sets the values to show. |
whenCellEmpty() | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell is empty. |
whenCellNotEmpty() | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell is not empty. |
whenDateAfter(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell date is after the specified value. |
whenDateAfter(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell date is after the specified relative date. |
whenDateBefore(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell date is before the specified date. |
whenDateBefore(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where a cell date is before the specified relative date. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where a cell date is equal to the specified date. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where a cell date is equal to the specified relative date. |
whenDateEqualToAny(dates) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell date is equal to any of the specified dates. |
whenDateNotEqualTo(date) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell date is not equal to the specified date. |
whenDateNotEqualToAny(dates) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell date is not equal to any of the specified dates. |
whenFormulaSatisfied(formula) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the specified formula (such as =B:B<C:C )
evaluates to true . |
whenNumberBetween(start, end) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number falls between, or is either of, two specified numbers. |
whenNumberEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number is equal to the specified value. |
whenNumberEqualToAny(numbers) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number is equal to any of the specified numbers. |
whenNumberGreaterThan(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number is greater than the specified value. |
whenNumberGreaterThanOrEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number is greater than or equal to the specified value. |
whenNumberLessThan(number) | FilterCriteriaBuilder | Sets the conditional conditional format rule to show cells where the cell number is less than the specified value. |
whenNumberLessThanOrEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number is less than or equal to the specified value. |
whenNumberNotBetween(start, end) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number doesn't fall between, and is neither of, two specified numbers. |
whenNumberNotEqualTo(number) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number is not equal to the specified value. |
whenNumberNotEqualToAny(numbers) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell number isn't equal to any of the specified numbers. |
whenTextContains(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text contains the specified text. |
whenTextDoesNotContain(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text doesn't contain the specified text. |
whenTextEndsWith(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text ends with the specified text. |
whenTextEqualTo(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text is equal to the specified text. |
whenTextEqualToAny(texts) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text is equal to any of the specified values. |
whenTextNotEqualTo(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text is not equal to the specified text. |
whenTextNotEqualToAny(texts) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text is not equal to any of the specified values. |
whenTextStartsWith(text) | FilterCriteriaBuilder | Sets the filter criteria to show cells where the cell text starts with the specified text. |
withCriteria(criteria, args) | FilterCriteriaBuilder | Sets the boolean criteria to criteria defined by BooleanCriteria values, typically
taken from the criteria and arguments of an existing criteria. |
Detailed documentation
build()
Constructs a filter criteria from the settings supplied to the builder.
Return
FilterCriteria
— A representation of the filter criteria.
copy()
Copies this filter criteria and creates a criteria builder that you can apply to another filter.
You can use this method with any type of filter. If you're using a sheet filter, you can copy the criteria to another column.
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Makes a copy of the filter criteria applied to column C. let criteria = filter.getColumnFilterCriteria(3).copy().build(); // Applies the copied criteria to column B. The copied criteria overwrites any existing // criteria on column B. filter.setColumnFilterCriteria(2, criteria);
Return
FilterCriteriaBuilder
— A filter criteria builder based on this filter criteria.
getCriteriaType()
Returns the criteria's boolean type, for example, CELL_EMPTY
. To learn about the types
of boolean criteria, see the BooleanCriteria
enum.
People often use this method to add criteria to a filter without replacing existing criteria.
- To get the arguments for the criteria, use
getCriteriaValues()
. - To use the criteria type and criteria values to create or modify filter criteria, see
withCriteria(criteria, args)
.
You can use this method for any type of filter. If the filter criteria isn't a boolean
condition, returns null
.
let ss = SpreadsheetApp.getActiveSheet(); // Gets the filter on the active sheet. let filter = ss.getFilter(); // Gets the criteria type and returns a string representing the criteria type object. let criteriaType = filter.getColumnFilterCriteria(2) .getCriteriaType() .toString(); // Logs the criteria type. console.log(criteriaType);
Return
BooleanCriteria
— The type of boolean criteria, or null
if the criteria isn't a boolean
condition.
getCriteriaValues()
Returns an array of arguments for boolean criteria. Some boolean criteria types don't have
arguments and return an empty array, for example, CELL_NOT_EMPTY
.
People often use this method to add criteria to a filter without replacing existing criteria.
- To get the boolean criteria type, use
getCriteriaType()
. - To use the criteria type and criteria values to create or modify a filter criteria, see
withCriteria(criteria, args)
.You can use this method for any type of filter.
let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter(); // Gets the values of the boolean criteria and logs them. For example, if the boolean // condition is whenNumberGreaterThan(10), then the logged value is 10. let criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues(); console.log(criteriaValues);
Return
Object[]
— An array of arguments appropriate to the boolean criteria type. The number of arguments and their type match the correspondingwhen...()
method of theFilterCriteriaBuilder
class.
getHiddenValues()
Returns the values that the filter hides.
Use this criteria with filters on Grid
sheets, the default type of sheet.
Grid sheets are sheets that aren't connected to a database. Returns null
if you call
this method for other types of filters.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); let filter = range.getFilter(); // Gets the filter criteria applied to column B, then gets the hidden values. let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues(); // Logs the hidden values. console.log(filterCriteria);
Return
String[]
— An array of values that the filter hides.
getVisibleBackgroundColor()
Returns the background color used as filter criteria. Cells with this background color remain visible.
Use this criteria with filters on Grid
sheets, the default type of sheet.
Grid sheets are sheets that aren't connected to a database. Returns null
if you call
this method for other types of filters.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Logs the background color that column B is filtered by as a hexadecimal string. let filter = range.getFilter(); let color = filter.getColumnFilterCriteria(2) .getVisibleBackgroundColor() .asRgbColor() .asHexString(); console.log(color);
Return
Color
— The background color used as filter criteria.
getVisibleForegroundColor()
Returns the foreground color used as a filter criteria. Cells with this foreground color remain visible.
Use this criteria with filters on Grid
sheets, the default type of sheet.
Grid sheets are sheets that aren't connected to a database. Returns null
if you call
this method for other types of filters.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Logs the foreground color that column B is filtered by as a hexadecimal string. let filter = range.getFilter(); let color = filter.getColumnFilterCriteria(2) .getVisibleForegroundColor() .asRgbColor() .asHexString(); console.log(color);
Return
Color
— The foreground color used as a filter criteria.
getVisibleValues()
Returns the values that the pivot table filter shows.
This criteria is only for filters on pivot tables that aren't connected to a database. Returns an empty array for other types of filters.
let ss = SpreadsheetApp.getActiveSheet(); // Gets the first pivot table on the sheet, then gets the visible values of its first filter. pivotTable = ss.getPivotTables()[0]; pivotFilterValues = pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues(); // Logs the visible values. console.log(pivotFilterValues);
Return
String[]
— An array of values that the pivot table filter shows.
setHiddenValues(values)
Sets the values to hide. Clears any existing visible or hidden values.
You can use this filter criteria for Grid
sheet filters. Grid sheets are
sheets with data that aren't connected to a database.
Parameters
Name | Type | Description |
---|---|---|
values | String[] | The list of values to hide. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
setVisibleBackgroundColor(visibleBackgroundColor)
Sets the background color used as a filter criteria. Cells with this background color remain visible. Setting a background color filter criteria removes the current color filter criteria from this builder.
You can use this filter criteria for Grid
sheet filters. Grid sheets are
sheets with data that aren't connected to a database.
Parameters
Name | Type | Description |
---|---|---|
visibleBackgroundColor | Color | The background color to set. This must be an RGB-style color, theme colors are not supported. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
setVisibleForegroundColor(visibleForegroundColor)
Sets the foreground color used as a filter criteria. Cells with this foreground color remain visible. Setting a foreground color filter criteria removes the current color filter criteria from this builder.
You can use this filter criteria for Grid
sheet filters. Grid sheets are
sheets with data that aren't connected to a database.
Parameters
Name | Type | Description |
---|---|---|
visibleForegroundColor | Color | The foreground color to set. This must be an RGB-style color, theme colors are not supported. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
setVisibleValues(values)
Sets the values to show. It clears any existing visible or hidden values.
You can use this criteria for filters on pivot tables that aren't connected to a database.
Parameters
Name | Type | Description |
---|---|---|
values | String[] | The list of values to show. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenCellEmpty()
Sets the filter criteria to show cells where the cell is empty.
You can use this criteria with any type of filter.
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenCellNotEmpty()
Sets the filter criteria to show cells where the cell is not empty.
You can use this criteria with any type of filter.
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateAfter(date)
Sets the filter criteria to show cells where the cell date is after the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | Date | The latest date. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateAfter(date)
Sets the filter criteria to show cells where the cell date is after the specified relative date.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | RelativeDate | The latest date relative to the date type selected. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateBefore(date)
Sets the filter criteria to show cells where the cell date is before the specified date.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | Date | The earliest unacceptable date. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateBefore(date)
Sets the filter criteria to show cells where a cell date is before the specified relative date.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | RelativeDate | The latest date relative to the date type selected. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateEqualTo(date)
Sets the filter criteria to show cells where a cell date is equal to the specified date.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | Date | The sole acceptable date. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateEqualTo(date)
Sets the filter criteria to show cells where a cell date is equal to the specified relative date.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | RelativeDate | The latest date relative to the date type selected. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateEqualToAny(dates)
Sets the filter criteria to show cells where the cell date is equal to any of the specified dates.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
dates | Date[] | The acceptable values. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateNotEqualTo(date)
Sets the filter criteria to show cells where the cell date is not equal to the specified date.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
date | Date | The latest date relative to the date type selected. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenDateNotEqualToAny(dates)
Sets the filter criteria to show cells where the cell date is not equal to any of the specified dates.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a date. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a date, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
dates | Date[] | The acceptable values. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenFormulaSatisfied(formula)
Sets the filter criteria to show cells where the specified formula (such as =B:B<C:C
)
evaluates to true
.
You can only use this criteria to filter data that isn't connected to a database.
Parameters
Name | Type | Description |
---|---|---|
formula | String | A custom formula that evaluates to true if the input is valid. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberBetween(start, end)
Sets the filter criteria to show cells where the cell number falls between, or is either of, two specified numbers.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
start | Number | The lowest acceptable value. |
end | Number | The highest acceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberEqualTo(number)
Sets the filter criteria to show cells where the cell number is equal to the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
number | Number | The sole acceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberEqualToAny(numbers)
Sets the filter criteria to show cells where the cell number is equal to any of the specified numbers.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
numbers | Number[] | The acceptable values. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberGreaterThan(number)
Sets the filter criteria to show cells where the cell number is greater than the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
number | Number | The highest unacceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberGreaterThanOrEqualTo(number)
Sets the filter criteria to show cells where the cell number is greater than or equal to the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
number | Number | The lowest acceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberLessThan(number)
Sets the conditional conditional format rule to show cells where the cell number is less than the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
number | Number | The lowest unacceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberLessThanOrEqualTo(number)
Sets the filter criteria to show cells where the cell number is less than or equal to the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
number | Number | The highest acceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberNotBetween(start, end)
Sets the filter criteria to show cells where the cell number doesn't fall between, and is neither of, two specified numbers.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
start | Number | The lowest unacceptable value. |
end | Number | The highest unacceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberNotEqualTo(number)
Sets the filter criteria to show cells where the cell number is not equal to the specified value.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
number | Number | The sole unacceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenNumberNotEqualToAny(numbers)
Sets the filter criteria to show cells where the cell number isn't equal to any of the specified numbers.
You can use this criteria with any type of filter. If you use this criteria with data that's connected to a database, the data type of the column you're filtering by must be a number. If the data isn't connected to a database, the data type of the column you're filtering by doesn't need to be a number, but if it's not, you might get unexpected results.
Parameters
Name | Type | Description |
---|---|---|
numbers | Number[] | The unacceptable values. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextContains(text)
Sets the filter criteria to show cells where the cell text contains the specified text.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
text | String | The value that the input must contain. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextDoesNotContain(text)
Sets the filter criteria to show cells where the cell text doesn't contain the specified text.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
text | String | The value that the input must not contain. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextEndsWith(text)
Sets the filter criteria to show cells where the cell text ends with the specified text.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
text | String | Text to compare against the end of the string. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextEqualTo(text)
Sets the filter criteria to show cells where the cell text is equal to the specified text.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
text | String | The sole acceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextEqualToAny(texts)
Sets the filter criteria to show cells where the cell text is equal to any of the specified values.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
texts | String[] | The acceptable values. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextNotEqualTo(text)
Sets the filter criteria to show cells where the cell text is not equal to the specified text.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
text | String | The unacceptable value. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextNotEqualToAny(texts)
Sets the filter criteria to show cells where the cell text is not equal to any of the specified values.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
texts | String[] | The unacceptable values. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
whenTextStartsWith(text)
Sets the filter criteria to show cells where the cell text starts with the specified text.
You can use this criteria with any type of filter.
Parameters
Name | Type | Description |
---|---|---|
text | String | Text to compare against the beginning of the string. |
Return
FilterCriteriaBuilder
— This builder, for chaining.
withCriteria(criteria, args)
Sets the boolean criteria to criteria defined by BooleanCriteria
values, typically
taken from the criteria
and arguments
of an existing criteria.
You can use this criteria with any type of filter, but some BooleanCriteria
aren't
applicable for all filters.
// Builds a filter criteria that is based on an existing criteria. var sheet = SpreadsheetApp.getActiveSheet(); var criteria = sheet.getFilter().getColumnFilterCriteria(1); var newCriteria = SpreadsheetApp.newFilterCriteria() .withCriteria(criteria.getCriteriaType(), criteria.getCriteriaValues()) .setHiddenValues(['c']) .build();
Parameters
Name | Type | Description |
---|---|---|
criteria | BooleanCriteria | The type of boolean criteria. |
args | Object[] | An array of arguments appropriate to the criteria type; the number of arguments and
their type match the corresponding when...() method above. |
Return
FilterCriteriaBuilder
— This builder, for chaining.