Excel.FilterCriteria interface

Paket:

excel

Stellt die auf eine Spalte angewendeten Filterkriterien dar.

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Eigenschaften

color	Die HTML-Farbzeichenfolge, die zum Filtern von Zellen verwendet wird. Wird mit cellColor und fontColor Filterung verwendet.
criterion1	Das erste verwendete Kriterium zum Filtern von Daten. Wird beim Filtern als Operator custom verwendet. Beispiel: ">50" für Zahlen größer als 50 oder "=*s" für Werte, die mit "s" enden. Wird als Zahl im Fall der obersten/unteren Elemente/Prozentsätze verwendet (z. B. "5" für die obersten 5 Elemente, wenn filterOn auf topItemsfestgelegt ist).
criterion2	Das zweite verwendete Kriterium zum Filtern von Daten. Wird nur als Operator im Fall der custom Filterung verwendet.
dynamicCriteria	Die dynamischen Kriterien aus dem Satz, die Excel.DynamicFilterCriteria auf diese Spalte angewendet werden sollen. Wird mit dynamic Filterung verwendet.
filterOn	Die Eigenschaft, die vom Filter verwendet wird, um zu bestimmen, ob die Werte sichtbar bleiben sollen.
icon	Das zum Filtern von Zellen verwendete Symbol. Wird mit icon Filterung verwendet.
operator	Der Operator, der verwendet wird, um kriterium 1 und 2 bei Verwendung von custom Filterung zu kombinieren.
subField	Die Eigenschaft, die vom Filter verwendet wird, um einen umfangreichen Filter für Rich-Werte zu erstellen.
values	Der Satz von Werten, die als Teil der values Filterung verwendet werden sollen.

Details zur Eigenschaft

color

Die HTML-Farbzeichenfolge, die zum Filtern von Zellen verwendet wird. Wird mit cellColor und fontColor Filterung verwendet.

color?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.2 ]

criterion1

Das erste verwendete Kriterium zum Filtern von Daten. Wird beim Filtern als Operator custom verwendet. Beispiel: ">50" für Zahlen größer als 50 oder "=*s" für Werte, die mit "s" enden.

Wird als Zahl im Fall der obersten/unteren Elemente/Prozentsätze verwendet (z. B. "5" für die obersten 5 Elemente, wenn filterOn auf topItemsfestgelegt ist).

criterion1?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.2 ]

criterion2

Das zweite verwendete Kriterium zum Filtern von Daten. Wird nur als Operator im Fall der custom Filterung verwendet.

criterion2?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.2 ]

dynamicCriteria

Die dynamischen Kriterien aus dem Satz, die Excel.DynamicFilterCriteria auf diese Spalte angewendet werden sollen. Wird mit dynamic Filterung verwendet.

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";

Eigenschaftswert

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"

Hinweise

[ API-Satz: ExcelApi 1.2 ]

filterOn

Die Eigenschaft, die vom Filter verwendet wird, um zu bestimmen, ob die Werte sichtbar bleiben sollen.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Beispiele

// 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

Das zum Filtern von Zellen verwendete Symbol. Wird mit icon Filterung verwendet.

icon?: Excel.Icon;

Eigenschaftswert

Excel.Icon

Hinweise

[ API-Satz: ExcelApi 1.2 ]

operator

Der Operator, der verwendet wird, um kriterium 1 und 2 bei Verwendung von custom Filterung zu kombinieren.

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

Eigenschaftswert

Excel.FilterOperator | "And" | "Or"

Hinweise

[ API-Satz: ExcelApi 1.2 ]

subField

Die Eigenschaft, die vom Filter verwendet wird, um einen umfangreichen Filter für Rich-Werte zu erstellen.

subField?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

values

Der Satz von Werten, die als Teil der values Filterung verwendet werden sollen.

values?: Array<string | FilterDatetime>;

Eigenschaftswert

Array<string | Excel.FilterDatetime>

Hinweise

[ API-Satz: ExcelApi 1.2 ]