ExcelScript.FilterCriteria interface

Пакет:

ExcelScript

Представляет условия фильтра, применяемые к столбцу.

Свойства

color	Строка цвета HTML, которая используется для фильтрации ячеек. Используется с cellColor и fontColor фильтрацией.
criterion1	Первый критерий фильтрации данных. Используется в качестве оператора в случае custom фильтрации. Например, ">50" для чисел больше 50 или "=*s" для значений, заканчиваемых на "s". Используется в качестве числа в случае верхних и нижних элементов/процентов (например, "5" для первых 5 элементов, если filterOn задано значение topItems).
criterion2	Второй критерий фильтрации данных. Используется только в качестве оператора в случае custom фильтрации.
dynamicCriteria	Динамические условия из набора, применяемого ExcelScript.DynamicFilterCriteria к этому столбцу. Используется с dynamic фильтрацией.
filterOn	Свойство, с помощью которого фильтр определяет, следует ли показывать значения.
icon	Значок, используемый для фильтрации ячеек. Используется с icon фильтрацией.
operator	Оператор, используемый для объединения критериев 1 и 2 при использовании custom фильтрации.
subField	Свойство, используемое фильтром для выполнения полнофункционированного фильтра по расширенным значениям.
values	Набор значений, используемых values в процессе фильтрации.

Сведения о свойстве

color

Строка цвета HTML, которая используется для фильтрации ячеек. Используется с cellColor и fontColor фильтрацией.

color?: string;

Значение свойства

string

criterion1

Первый критерий фильтрации данных. Используется в качестве оператора в случае custom фильтрации. Например, ">50" для чисел больше 50 или "=*s" для значений, заканчиваемых на "s".

Используется в качестве числа в случае верхних и нижних элементов/процентов (например, "5" для первых 5 элементов, если filterOn задано значение topItems).

criterion1?: string;

Значение свойства

string

Примеры

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values 
 * (of column C values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the lowest 10 values in column C
  // (index 2, assuming the used range spans from at least A:C).
  const filterCriteria: ExcelScript.FilterCriteria = {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.bottomItems
  };
  currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
}

criterion2

Второй критерий фильтрации данных. Используется только в качестве оператора в случае custom фильтрации.

criterion2?: string;

Значение свойства

string

Примеры

/**
 * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Apply the filter to the "Type" column.
  const typeColumn = table.getColumnByName("Type");
  typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}

dynamicCriteria

Динамические условия из набора, применяемого ExcelScript.DynamicFilterCriteria к этому столбцу. Используется с dynamic фильтрацией.

dynamicCriteria?: DynamicFilterCriteria;

Значение свойства

ExcelScript.DynamicFilterCriteria

filterOn

Свойство, с помощью которого фильтр определяет, следует ли показывать значения.

filterOn: FilterOn;

Значение свойства

ExcelScript.FilterOn

icon

Значок, используемый для фильтрации ячеек. Используется с icon фильтрацией.

icon?: Icon;

Значение свойства

ExcelScript.Icon

operator

Оператор, используемый для объединения критериев 1 и 2 при использовании custom фильтрации.

operator?: FilterOperator;

Значение свойства

ExcelScript.FilterOperator

subField

Свойство, используемое фильтром для выполнения полнофункционированного фильтра по расширенным значениям.

subField?: string;

Значение свойства

string

values

Набор значений, используемых values в процессе фильтрации.

values?: Array<string | FilterDatetime>;

Значение свойства

Array<string | ExcelScript.FilterDatetime>