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

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

Class FilterCriteria | Apps Script

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

Use this class to get information about or copy the criteria on existing filters.

• To create a new filter, refer to the following:
  • For sheets, use Range.createFilter().
  • For pivot tables, use PivotTable.addFilter(sourceDataColumn, filterCriteria).
  • For sheets that are connected to a database, use DataSourceSheet.addFilter(columnName, filterCriteria).
  • For pivot tables that are connected to a database, use DataSourcePivotTable.addFilter(columnName, filterCriteria).
• To create the criteria for any type of filter, refer to SpreadsheetApp.newFilterCriteria() and FilterCriteriaBuilder.

The following sample gets the filter that applies to the range

, gets the criteria applied to column C, and copies the criteria to column B.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
const 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);

The following sample gets the filter that applies to the given range and logs the values from column B that the filter hides.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

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.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const 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);

FilterCriteriaBuilder — A filter criteria builder based on this filter criteria.

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 boolean condition 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 FilterCriteriaBuilder.withCriteria(criteria, args).

You can use this method for any type of filter. If the filter criteria isn't a boolean condition, returns null.

const ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
const filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type
// object.
const criteriaType =
    filter.getColumnFilterCriteria(2).getCriteriaType().toString();
// Logs the criteria type.
console.log(criteriaType);

BooleanCriteria — The type of boolean criteria, or null if the criteria isn't a boolean condition.

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 boolean condition 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 FilterCriteriaBuilder.withCriteria(criteria, args).

  You can use this method for any type of filter.

  const ss = SpreadsheetApp.getActiveSheet();
  const 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.
  const 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 corresponding when...() method of the FilterCriteriaBuilder class.

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. Returns null if you call this method for other types of filters.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the background color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

Color — The background color used as filter criteria.

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. Returns null if you call this method for other types of filters.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the foreground color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

Color — The foreground color used as a filter criteria.

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.

const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its
// first filter.
const pivotTable = ss.getPivotTables()[0];
const pivotFilterValues =
    pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

String[] — An array of values that the pivot table filter shows.

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 `FilterCriteria` class allows you to retrieve and manipulate filter criteria in Google Sheets for ranges, pivot tables, and data source sheets."],["You can use `FilterCriteria` to copy filter criteria between columns, identify hidden values, and programmatically adjust filter settings."],["`FilterCriteria` provides methods to access details like the boolean criteria type, arguments, and visible/hidden values used in filters."],["When working with sheet filters, you can leverage methods like `getHiddenValues()`, `getVisibleBackgroundColor()`, and `getVisibleForegroundColor()` to understand and modify filter criteria based on cell properties."],["For pivot tables, the `getVisibleValues()` method is useful for retrieving the values that are currently displayed by the filter."]]],["FilterCriteria provides information about existing filters and facilitates copying them. You can copy filter criteria to other columns using `copy()` and `build()`. `getHiddenValues()` retrieves values hidden by a filter, while `getVisibleValues()` gets values shown by pivot table filters. `getCriteriaType()` and `getCriteriaValues()` provide details on boolean filter conditions. `getVisibleBackgroundColor()` and `getVisibleForegroundColor()` identify filter criteria based on cell colors. Use `Range.createFilter()` or `PivotTable.addFilter()` and `DataSourceSheet.addFilter()` and `DataSourcePivotTable.addFilter()` to create new filters.\n"]]

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