Excel.FilterCriteria interface

  • Ссылка
Пакет:
excel

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

Свойства

color

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

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

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

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

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

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

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

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

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

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

color

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

color?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.2 ]

criterion1

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

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

criterion1?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.2 ]

criterion2

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

criterion2?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.2 ]

dynamicCriteria

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

dynamicCriteria?: Excel.DynamicFilterCriteria | "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";

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

Excel.DynamicFilterCriteria | "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"

Комментарии

[ Набор API: ExcelApi 1.2 ]

filterOn

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

filterOn: Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom";

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

Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom"

Комментарии

[ Набор API: ExcelApi 1.2 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

icon

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

icon?: Excel.Icon;

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

Excel.Icon

Комментарии

[ Набор API: ExcelApi 1.2 ]

operator

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

operator?: Excel.FilterOperator | "And" | "Or";

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

Excel.FilterOperator | "And" | "Or"

Комментарии

[ Набор API: ExcelApi 1.2 ]

values

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

values?: Array<string | FilterDatetime>;

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

Array<string | Excel.FilterDatetime>

Комментарии

[ Набор API: ExcelApi 1.2 ]