Compartilhar via

Excel.FilterCriteria interface

  • Referência
Pacote:
excel

Representa os critérios de filtragem aplicados a uma coluna.

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Propriedades

color

A cadeia HTML de cor usada para filtrar células. Utilizado com cellColor e fontColor filtragem.
criterion1

O primeiro critério usado para filtrar os dados. Utilizado como operador no caso da custom filtragem. Por exemplo, ">50" para números superiores a 50 ou "=*s" para valores que terminem em "s".

Utilizado como um número no caso de itens/percentagens superiores/inferiores (por exemplo, "5" para os 5 principais itens, se filterOn estiver definido como topItems).
criterion2

O segundo critério usado para filtrar os dados. Utilizado apenas como operador no caso da custom filtragem.
dynamicCriteria

Os critérios dinâmicos do Excel.DynamicFilterCriteria conjunto a aplicar nesta coluna. Utilizado com dynamic filtragem.
filterOn

A propriedade usada pelo filtro para determinar se os valores devem ficar visíveis.
icon

O ícone usado para filtrar células. Utilizado com icon filtragem.
operator

O operador utilizado para combinar critérios 1 e 2 ao utilizar custom a filtragem.
subField

A propriedade utilizada pelo filtro para efetuar um filtro avançado em valores avançados.
values

O conjunto de valores a utilizar como parte da values filtragem.

Detalhes da propriedade

color

A cadeia HTML de cor usada para filtrar células. Utilizado com cellColor e fontColor filtragem.

color?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

criterion1

O primeiro critério usado para filtrar os dados. Utilizado como operador no caso da custom filtragem. Por exemplo, ">50" para números superiores a 50 ou "=*s" para valores que terminem em "s".

Utilizado como um número no caso de itens/percentagens superiores/inferiores (por exemplo, "5" para os 5 principais itens, se filterOn estiver definido como topItems).

criterion1?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

criterion2

O segundo critério usado para filtrar os dados. Utilizado apenas como operador no caso da custom filtragem.

criterion2?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

dynamicCriteria

Os critérios dinâmicos do Excel.DynamicFilterCriteria conjunto a aplicar nesta coluna. Utilizado com dynamic filtragem.

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

Valor da propriedade

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"

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

filterOn

A propriedade usada pelo filtro para determinar se os valores devem ficar visíveis.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Exemplos

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

O ícone usado para filtrar células. Utilizado com icon filtragem.

icon?: Excel.Icon;

Valor da propriedade

Excel.Icon

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

operator

O operador utilizado para combinar critérios 1 e 2 ao utilizar custom a filtragem.

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

Valor da propriedade

Excel.FilterOperator | "And" | "Or"

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

subField

A propriedade utilizada pelo filtro para efetuar um filtro avançado em valores avançados.

subField?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

values

O conjunto de valores a utilizar como parte da values filtragem.

values?: Array<string | FilterDatetime>;

Valor da propriedade

Array<string | Excel.FilterDatetime>

Comentários

[ Conjunto de API: ExcelApi 1.2 ]