ExcelScript.Filter interface

Пакет:

ExcelScript

Управляет фильтрацией столбца таблицы.

Комментарии

Примеры

/**
 * This script adds a table filter to only show the top 10% of values 
 * belonging to a particular column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table on the current worksheet.
    const table = workbook.getActiveWorksheet().getTables()[0];

    // Get the filter for the "PageViews" table column.
    const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();

    // Apply a filter to only show the rows with the top 10% of values in this column.
    pageViewFilter.applyTopPercentFilter(10);
}

Методы

apply(criteria)	Применяет заданные условия фильтра для определенного столбца.
applyBottomItemsFilter(count)	Применяет к столбцу фильтр по количеству элементов снизу.
applyBottomPercentFilter(percent)	Применяет к столбцу фильтр по проценту элементов снизу.
applyCellColorFilter(color)	Применяет к столбцу фильтр по цвету ячеек.
applyCustomFilter(criteria1, criteria2, oper)	Примените фильтр "Значок" к столбцу для заданных строк условий.
applyDynamicFilter(criteria)	Применяет к столбцу динамический фильтр.
applyFontColorFilter(color)	Применяет к столбцу фильтр по цвету шрифта.
applyIconFilter(icon)	Примените фильтр "Значок" к столбцу для заданного значка.
applyTopItemsFilter(count)	Применяет к столбцу фильтр по количеству элементов сверху.
applyTopPercentFilter(percent)	Применяет к столбцу фильтр по проценту элементов сверху.
applyValuesFilter(values)	Применяет к столбцу фильтр по значениям.
clear()	Сбрасывает фильтр для определенного столбца.
getCriteria()	Текущий фильтр, заданный для определенного столбца.

Сведения о методе

apply(criteria)

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

apply(criteria: FilterCriteria): void;

Параметры

criteria

ExcelScript.FilterCriteria

Применяемые условия.

Возвращаемое значение

void

applyBottomItemsFilter(count)

Применяет к столбцу фильтр по количеству элементов снизу.

applyBottomItemsFilter(count: number): void;

Параметры

count

number

Количество элементов снизу, которые должны отображаться.

Возвращаемое значение

void

applyBottomPercentFilter(percent)

Применяет к столбцу фильтр по проценту элементов снизу.

applyBottomPercentFilter(percent: number): void;

Параметры

percent

number

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

Возвращаемое значение

void

applyCellColorFilter(color)

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

applyCellColorFilter(color: string): void;

Параметры

color

string

Цвет фона ячеек, которые должны отображаться.

Возвращаемое значение

void

applyCustomFilter(criteria1, criteria2, oper)

Примените фильтр "Значок" к столбцу для заданных строк условий.

applyCustomFilter(
            criteria1: string,
            criteria2?: string,
            oper?: FilterOperator
        ): void;

Параметры

criteria1

string

Строка первого условия.

criteria2

string

Необязательный параметр. Строка второго условия.

oper

ExcelScript.FilterOperator

Необязательный параметр. Оператор, который описывает способ объединения двух условий.

Возвращаемое значение

void

Примеры

/**
 * The script filters rows from a table based on numerical values.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Filter to only show rows with values in the "Sales" column that are 
  // greater than or equal to 2000.
  table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
}

applyDynamicFilter(criteria)

Применяет к столбцу динамический фильтр.

applyDynamicFilter(criteria: DynamicFilterCriteria): void;

Параметры

criteria

ExcelScript.DynamicFilterCriteria

Динамические условия, которые необходимо применить.

Возвращаемое значение

void

Примеры

/**
 * This script applies a filter to a table that filters it 
 * to only show rows with dates from the previous month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the table named "ReportTable".
  const table = workbook.getTable("ReportTable");

  // Get the column with the header "Date".
  const dateColumn = table.getColumnByName("Date");

  // Apply a dynamic filter to the column. 
  // `lastMonth` will only show rows with a date from the previous month.
  dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
}

applyFontColorFilter(color)

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

applyFontColorFilter(color: string): void;

Параметры

color

string

Цвет шрифта ячеек, которые должны отображаться.

Возвращаемое значение

void

applyIconFilter(icon)

Примените фильтр "Значок" к столбцу для заданного значка.

applyIconFilter(icon: Icon): void;

Параметры

icon

ExcelScript.Icon

Значки ячеек, которые должны отображаться.

Возвращаемое значение

void

applyTopItemsFilter(count)

Применяет к столбцу фильтр по количеству элементов сверху.

applyTopItemsFilter(count: number): void;

Параметры

count

number

Количество элементов сверху, которые должны отображаться.

Возвращаемое значение

void

applyTopPercentFilter(percent)

Применяет к столбцу фильтр по проценту элементов сверху.

applyTopPercentFilter(percent: number): void;

Параметры

percent

number

Процент элементов сверху, которые должны отображаться.

Возвращаемое значение

void

applyValuesFilter(values)

Применяет к столбцу фильтр по значениям.

applyValuesFilter(values: Array<string | FilterDatetime>): void;

Параметры

values

Array<string | ExcelScript.FilterDatetime>

Список значений, которые должны отображаться. Это должен быть массив строк или массив ExcelScript.FilterDateTime объектов.

Возвращаемое значение

void

Примеры

/**
 * 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"]);
}

clear()

Сбрасывает фильтр для определенного столбца.

clear(): void;

Возвращаемое значение

void

Примеры

/**
 * This script shows how to clear a filter from a table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Clear the filter for the table column named "Status".
  const statusColumnFilter = table.getColumn("Status").getFilter();
  statusColumnFilter.clear();
}

getCriteria()

Текущий фильтр, заданный для определенного столбца.

getCriteria(): FilterCriteria;

Возвращаемое значение

ExcelScript.FilterCriteria