Excel.FilterCriteria interface

Chaîne de couleur HTML utilisée pour filtrer des cellules. Utilisé avec cellColor et fontColor le filtrage.

color?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Premier critère utilisé pour filtrer des données. Utilisé en tant qu’opérateur dans le cas du custom filtrage. Par exemple, «> 50 » pour les nombres supérieurs à 50 ou « =*s » pour les valeurs se terminant par « s ».

Utilisé comme nombre dans le cas d’éléments/pourcentages supérieurs/inférieurs (par exemple, « 5 » pour les 5 premiers éléments si filterOn est défini sur topItems).

criterion1?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Second critère utilisé pour filtrer des données. Utilisé uniquement comme opérateur dans le cas d’un custom filtrage.

criterion2?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Critères dynamiques de l’ensemble Excel.DynamicFilterCriteria à appliquer à cette colonne. Utilisé avec dynamic le filtrage.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Propriété utilisée par le filtre pour déterminer si les valeurs doivent rester visibles.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Exemples

// 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();
});

Icône utilisée pour filtrer des cellules. Utilisé avec icon le filtrage.

icon?: Excel.Icon;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Opérateur utilisé pour combiner les critères 1 et 2 lors de l’utilisation custom du filtrage.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Propriété utilisée par le filtre pour effectuer un filtre enrichi sur des valeurs riches.

subField?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Ensemble de valeurs à utiliser dans le cadre du values filtrage.

values?: Array<string | FilterDatetime>;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]