ExcelScript.AutoFilter interface

Paquete:

ExcelScript

Representa el AutoFilter objeto . Autofiltro convierte los valores de la columna de Excel en filtros específicos basados en el contenido de la celda.

Comentarios

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) {
  // Get the autoFilter of the first table in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();
  const autoFilter = currentSheet.getAutoFilter();

  // 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).
  autoFilter.apply(dataRange, 2, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.bottomItems
  });
}

Métodos

apply(range, columnIndex, criteria)	Aplica el objecto AutoFilter a un rango. Esto filtra la columna si se especifican el índice de columna y los criterios de filtro.
clearColumnCriteria(columnIndex)	Borra los criterios de filtro de columna del Autofiltro.
clearCriteria()	Borra los criterios de filtro y el estado de ordenación del Autofiltro.
getCriteria()	Matriz que contiene todos los criterios de filtro de un intervalo autofiltrado.
getEnabled()	Especifica si el autofiltro está habilitado.
getIsDataFiltered()	Especifica si autofiltro tiene criterios de filtro.
getRange()	Devuelve el Range objeto que representa el intervalo al que se aplica el Autofiltro. Si no hay ningún Range objeto asociado al Autofiltro, este método devuelve undefined.
reapply()	Aplica el objeto autofiltro especificado actualmente en el intervalo.
remove()	Quita el AutoFilter para el intervalo.

Detalles del método

apply(range, columnIndex, criteria)

Aplica el objecto AutoFilter a un rango. Esto filtra la columna si se especifican el índice de columna y los criterios de filtro.

apply(
            range: Range | string,
            columnIndex?: number,
            criteria?: FilterCriteria
        ): void;

Parámetros

range

ExcelScript.Range | string

Intervalo en el que se aplicará el Autofiltro.

columnIndex

number

Índice de columna de base cero al que se aplica el Autofiltro.

criteria

ExcelScript.FilterCriteria

Criterios de filtro.

Devoluciones

void

Ejemplos

/**
 * This script applies a filter to a table so that 
 * only rows with values in column 1 that start with "L" are shown.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the autoFilter of the first table in the current worksheet.
  const table = workbook.getActiveWorksheet().getTables()[0];
  const autoFilter = table.getAutoFilter();

  // Filter to only include values that start with "L".
  const filterCriteria: ExcelScript.FilterCriteria = {
    filterOn: ExcelScript.FilterOn.custom,
    criterion1: "L*"
  };
  
  // Apply the filter to column 1 (zero-based).
  autoFilter.apply(table.getRange(), 1, filterCriteria);
}

clearColumnCriteria(columnIndex)

Borra los criterios de filtro de columna del Autofiltro.

clearColumnCriteria(columnIndex: number): void;

Parámetros

columnIndex

number

Índice de columna de base cero, que representa qué filtro de columna debe borrarse. Si no se admite el valor de índice (por ejemplo, si el valor es un número negativo o si el valor es mayor que el número de columnas disponibles en el intervalo), se producirá un InvalidArgument error.

Devoluciones

void

clearCriteria()

Borra los criterios de filtro y el estado de ordenación del Autofiltro.

clearCriteria(): void;

Devoluciones

void

Ejemplos

/**
 * This script clears any applied criteria from the worksheet's autoFilter.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();

  // Clear all the criteria currently applied to the autoFilter.
  currentSheet.getAutoFilter().clearCriteria();
}

getCriteria()

Matriz que contiene todos los criterios de filtro de un intervalo autofiltrado.

getCriteria(): FilterCriteria[];

Devoluciones

ExcelScript.FilterCriteria[]

getEnabled()

Especifica si el autofiltro está habilitado.

getEnabled(): boolean;

Devoluciones

boolean

getIsDataFiltered()

Especifica si autofiltro tiene criterios de filtro.

getIsDataFiltered(): boolean;

Devoluciones

boolean

getRange()

Devuelve el Range objeto que representa el intervalo al que se aplica el Autofiltro. Si no hay ningún Range objeto asociado al Autofiltro, este método devuelve undefined.

getRange(): Range;

Devoluciones

ExcelScript.Range

reapply()

Aplica el objeto autofiltro especificado actualmente en el intervalo.

reapply(): void;

Devoluciones

void

remove()

Quita el AutoFilter para el intervalo.

remove(): void;

Devoluciones

void