Excel.Filter class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.2 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
criteria	Текущий фильтр, заданный для определенного столбца.

Методы

apply(criteria)	Применяет заданные условия фильтра для определенного столбца.
applyBottomItemsFilter(count)	Применяет к столбцу фильтр по количеству элементов снизу.
applyBottomPercentFilter(percent)	Применяет к столбцу фильтр по проценту элементов снизу.
applyCellColorFilter(color)	Применяет к столбцу фильтр по цвету ячеек.
applyCustomFilter(criteria1, criteria2, oper)	Примените фильтр "Значок" к столбцу для заданных строк условий.
applyCustomFilter(criteria1, criteria2, operString)	Примените фильтр "Значок" к столбцу для заданных строк условий.
applyDynamicFilter(criteria)	Применяет к столбцу динамический фильтр.
applyDynamicFilter(criteriaString)	Применяет к столбцу динамический фильтр.
applyFontColorFilter(color)	Применяет к столбцу фильтр по цвету шрифта.
applyIconFilter(icon)	Примените фильтр "Значок" к столбцу для заданного значка.
applyTopItemsFilter(count)	Применяет к столбцу фильтр по количеству элементов сверху.
applyTopPercentFilter(percent)	Применяет к столбцу фильтр по проценту элементов сверху.
applyValuesFilter(values)	Применяет к столбцу фильтр по значениям.
clear()	Сбрасывает фильтр для определенного столбца.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Filter объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.FilterData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Excel.RequestContext

criteria

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

readonly criteria: Excel.FilterCriteria;

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

Excel.FilterCriteria

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

apply(criteria)

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

apply(criteria: Excel.FilterCriteria): void;

Параметры

criteria

Excel.FilterCriteria

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyBottomItemsFilter(count)

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

applyBottomItemsFilter(count: number): void;

Параметры

count

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyBottomPercentFilter(percent)

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

applyBottomPercentFilter(percent: number): void;

Параметры

percent

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyCellColorFilter(color)

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

applyCellColorFilter(color: string): void;

Параметры

color

string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, oper)

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

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

Параметры

criteria1

string

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

criteria2

string

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

oper

Excel.FilterOperator

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, operString)

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

applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;

Параметры

criteria1

string

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

criteria2

string

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

operString

"And" | "Or"

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyDynamicFilter(criteria)

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

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

Параметры

criteria

Excel.DynamicFilterCriteria

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyDynamicFilter(criteriaString)

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

applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void;

Параметры

criteriaString

"Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyFontColorFilter(color)

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

applyFontColorFilter(color: string): void;

Параметры

color

string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyIconFilter(icon)

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

applyIconFilter(icon: Excel.Icon): void;

Параметры

icon

Excel.Icon

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyTopItemsFilter(count)

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

applyTopItemsFilter(count: number): void;

Параметры

count

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyTopPercentFilter(percent)

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

applyTopPercentFilter(percent: number): void;

Параметры

percent

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

applyValuesFilter(values)

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

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

Параметры

values

Array<string | Excel.FilterDatetime>

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

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

clear()

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

clear(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.2 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

Параметры

options

Excel.Interfaces.FilterLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

Excel.Filter

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.Filter;

Параметры

propertyNames

string | string[]

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

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

Excel.Filter

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Filter;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Excel.Filter

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Filter объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.FilterData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.FilterData;

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

Excel.Interfaces.FilterData