Excel.FilterCriteria interface

  • Referencia
Paquete:
excel

Representa los criterios de filtrado que se aplican a una columna.

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Propiedades

color

Cadena de color HTML que se usa para filtrar las celdas. Se usa con cellColor y fontColor filtrado.
criterion1

Primer criterio usado para filtrar los datos. Se usa como operador en el caso de custom filtrado. Por ejemplo, ">50" para números mayores que 50 o "=*s" para los valores que terminan en "s".

Se usa como número en el caso de los elementos/porcentajes superior/inferior (por ejemplo, "5" para los 5 elementos principales si filterOn está establecido en topItems).
criterion2

Segundo criterio usado para filtrar los datos. Solo se usa como operador en el caso de custom filtrado.
dynamicCriteria

Criterios dinámicos del Excel.DynamicFilterCriteria conjunto que se aplicarán en esta columna. Se usa con dynamic el filtrado.
filterOn

Propiedad usada por el filtro para determinar si los valores deben permanecer visibles.
icon

Icono usado para filtrar las celdas. Se usa con icon el filtrado.
operator

El operador usado para combinar los criterios 1 y 2 al usar custom el filtrado.
subField

Propiedad usada por el filtro para realizar un filtro enriquecido en valores enriquecidos.
values

Conjunto de valores que se van a usar como parte del values filtrado.

Detalles de las propiedades

color

Cadena de color HTML que se usa para filtrar las celdas. Se usa con cellColor y fontColor filtrado.

color?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

criterion1

Primer criterio usado para filtrar los datos. Se usa como operador en el caso de custom filtrado. Por ejemplo, ">50" para números mayores que 50 o "=*s" para los valores que terminan en "s".

Se usa como número en el caso de los elementos/porcentajes superior/inferior (por ejemplo, "5" para los 5 elementos principales si filterOn está establecido en topItems).

criterion1?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

criterion2

Segundo criterio usado para filtrar los datos. Solo se usa como operador en el caso de custom filtrado.

criterion2?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

dynamicCriteria

Criterios dinámicos del Excel.DynamicFilterCriteria conjunto que se aplicarán en esta columna. Se usa con dynamic el filtrado.

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 de propiedad

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"

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

filterOn

Propiedad usada por el filtro para determinar si los valores deben permanecer visibles.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Ejemplos

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

Icono usado para filtrar las celdas. Se usa con icon el filtrado.

icon?: Excel.Icon;

Valor de propiedad

Excel.Icon

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

operator

El operador usado para combinar los criterios 1 y 2 al usar custom el filtrado.

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

Valor de propiedad

Excel.FilterOperator | "And" | "Or"

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

subField

Propiedad usada por el filtro para realizar un filtro enriquecido en valores enriquecidos.

subField?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

values

Conjunto de valores que se van a usar como parte del values filtrado.

values?: Array<string | FilterDatetime>;

Valor de propiedad

Array<string | Excel.FilterDatetime>

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]