ExcelScript.FilterCriteria interface

Paquete:

ExcelScript

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

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 ExcelScript.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

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

Ejemplos

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values 
 * (of column C values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the lowest 10 values in column C
  // (index 2, assuming the used range spans from at least A:C).
  const filterCriteria: ExcelScript.FilterCriteria = {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.bottomItems
  };
  currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
}

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

Ejemplos

/**
 * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Apply the filter to the "Type" column.
  const typeColumn = table.getColumnByName("Type");
  typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}

dynamicCriteria

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

dynamicCriteria?: DynamicFilterCriteria;

Valor de propiedad

ExcelScript.DynamicFilterCriteria

filterOn

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

filterOn: FilterOn;

Valor de propiedad

ExcelScript.FilterOn

icon

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

icon?: Icon;

Valor de propiedad

ExcelScript.Icon

operator

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

operator?: FilterOperator;

Valor de propiedad

ExcelScript.FilterOperator

subField

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

subField?: string;

Valor de propiedad

string

values

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

values?: Array<string | FilterDatetime>;

Valor de propiedad

Array<string | ExcelScript.FilterDatetime>