Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.google.com/apps-script/reference/spreadsheet/filter below:

Class Filter | Apps Script

Stay organized with collections Save and categorize content based on your preferences.

Use this class to modify existing filters on Grid sheets, the default type of sheet. Grid sheets are regular sheets with data that aren't connected to a database.

If a filter doesn’t exist on the sheet yet, create one using Range.createFilter().

To use this class, you must first access the grid sheet filter using Range.getFilter() or Sheet.getFilter().

The below sample gets the filter on the active sheet and removes it.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

The below sample gets the filter on the active sheet, then uses the

method from this class to log the range that the filter applies to.

const ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Gets the filter criteria on the specified column, or null if the column doesn't have filter criteria applied to it.

To get more details about the filter criteria, chain this method with methods from the FilterCriteria class.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the filter criteria applied to column B of the active sheet
// and logs the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

FilterCriteria — The filter criteria.

Scripts that use this method require authorization with one or more of the following scopes:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Gets the range this filter applies to.

// Gets the existing filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Range — The filter's range. To get the range in A1 notation, chain this method with Range.getA1Notation().

Scripts that use this method require authorization with one or more of the following scopes:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Removes this filter.

// Removes the filter from the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.remove();

Scripts that use this method require authorization with one or more of the following scopes:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Removes the filter criteria from the specified column.

// Removes the filter criteria from column B.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

Filter — The filter, for chaining.

Scripts that use this method require authorization with one or more of the following scopes:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Sets the filter criteria on the specified column. First, create the filter criteria builder using SpreadsheetApp.newFilterCriteria(). Then add criteria to the builder using the FilterCriteriaBuilder class. After you've built your criteria, set it as the filterCriteria parameter for this method.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['Hello', 'World'])
                     .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

Filter — The filter, for chaining.

Scripts that use this method require authorization with one or more of the following scopes:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Sorts the filtered range by the specified column, excluding the first row (the header row) in the range this filter applies to.

// Gets the existing filter and sorts it by column B in ascending order.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

Filter — The filter, for chaining.

Scripts that use this method require authorization with one or more of the following scopes:

• https://www.googleapis.com/auth/spreadsheets.currentonly
• https://www.googleapis.com/auth/spreadsheets

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["The `Filter` class allows modification of existing filters or creation of new ones on Google Sheets Grid sheets (regular sheets with unconnected data)."],["Access the filter using `Range.getFilter()` or `Sheet.getFilter()` before applying `Filter` class methods."],["Key functionalities include removing a filter, getting the filter's range, getting or setting column-specific filter criteria, and sorting the filtered range."],["Utilize `FilterCriteriaBuilder` to construct and apply specific filter criteria through the `setColumnFilterCriteria` method."],["Refer to individual method documentation for detailed usage instructions, parameters, and authorization requirements."]]],[]]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4