ExcelScript.Filter interface

Paquete:

ExcelScript

Administra el filtrado de la columna de una tabla.

Comentarios

Ejemplos

/**
 * This script adds a table filter to only show the top 10% of values 
 * belonging to a particular column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table on the current worksheet.
    const table = workbook.getActiveWorksheet().getTables()[0];

    // Get the filter for the "PageViews" table column.
    const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();

    // Apply a filter to only show the rows with the top 10% of values in this column.
    pageViewFilter.applyTopPercentFilter(10);
}

Métodos

apply(criteria)	Aplicar los criterios de filtro especificados en la columna especificada.
applyBottomItemsFilter(count)	Aplicar un filtro de "Elemento inferior" a la columna para el número de elementos especificado.
applyBottomPercentFilter(percent)	Aplicar un filtro de "Porcentaje inferior" a la columna para el porcentaje de elementos especificado.
applyCellColorFilter(color)	Aplicar un filtro de "Color de celda" a la columna para el color especificado.
applyCustomFilter(criteria1, criteria2, oper)	Aplique un filtro "Icon" a la columna para las cadenas de criterios especificadas.
applyDynamicFilter(criteria)	Aplicar un filtro "Dinámico" a la columna.
applyFontColorFilter(color)	Aplicar un filtro de "Color de fuente" a la columna para el color especificado.
applyIconFilter(icon)	Aplique un filtro "Icon" a la columna para el icono especificado.
applyTopItemsFilter(count)	Aplicar un filtro de "Elemento superior" a la columna para el número de elementos especificado.
applyTopPercentFilter(percent)	Aplicar un filtro de "Porcentaje superior" a la columna para el porcentaje de elementos especificado.
applyValuesFilter(values)	Aplicar un filtro "Valores" a la columna para los valores especificados.
clear()	Borrar el filtro de la columna especificada.
getCriteria()	Filtro aplicado actualmente en la columna especificada.

Detalles del método

apply(criteria)

Aplicar los criterios de filtro especificados en la columna especificada.

apply(criteria: FilterCriteria): void;

Parámetros

criteria

ExcelScript.FilterCriteria

Criterios que se aplicarán.

Devoluciones

void

applyBottomItemsFilter(count)

Aplicar un filtro de "Elemento inferior" a la columna para el número de elementos especificado.

applyBottomItemsFilter(count: number): void;

Parámetros

count

number

Número de elementos desde la parte inferior que se van a mostrar.

Devoluciones

void

applyBottomPercentFilter(percent)

Aplicar un filtro de "Porcentaje inferior" a la columna para el porcentaje de elementos especificado.

applyBottomPercentFilter(percent: number): void;

Parámetros

percent

number

Porcentaje de elementos desde la parte inferior que se van a mostrar.

Devoluciones

void

applyCellColorFilter(color)

Aplicar un filtro de "Color de celda" a la columna para el color especificado.

applyCellColorFilter(color: string): void;

Parámetros

color

string

Color de fondo de las celdas que se van a mostrar.

Devoluciones

void

applyCustomFilter(criteria1, criteria2, oper)

Aplique un filtro "Icon" a la columna para las cadenas de criterios especificadas.

applyCustomFilter(
            criteria1: string,
            criteria2?: string,
            oper?: FilterOperator
        ): void;

Parámetros

criteria1

string

Primera cadena de criterios.

criteria2

string

Opcional. Segunda cadena de criterios.

oper

ExcelScript.FilterOperator

Opcional. El operador que describe cómo se combinan los dos criterios.

Devoluciones

void

Ejemplos

/**
 * The script filters rows from a table based on numerical values.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Filter to only show rows with values in the "Sales" column that are 
  // greater than or equal to 2000.
  table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
}

applyDynamicFilter(criteria)

Aplicar un filtro "Dinámico" a la columna.

applyDynamicFilter(criteria: DynamicFilterCriteria): void;

Parámetros

criteria

ExcelScript.DynamicFilterCriteria

Criterios dinámicos que se aplicarán.

Devoluciones

void

Ejemplos

/**
 * This script applies a filter to a table that filters it 
 * to only show rows with dates from the previous month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the table named "ReportTable".
  const table = workbook.getTable("ReportTable");

  // Get the column with the header "Date".
  const dateColumn = table.getColumnByName("Date");

  // Apply a dynamic filter to the column. 
  // `lastMonth` will only show rows with a date from the previous month.
  dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
}

applyFontColorFilter(color)

Aplicar un filtro de "Color de fuente" a la columna para el color especificado.

applyFontColorFilter(color: string): void;

Parámetros

color

string

Color de fuente de las celdas que se van a mostrar.

Devoluciones

void

applyIconFilter(icon)

Aplique un filtro "Icon" a la columna para el icono especificado.

applyIconFilter(icon: Icon): void;

Parámetros

icon

ExcelScript.Icon

Iconos de las celdas que se van a mostrar.

Devoluciones

void

applyTopItemsFilter(count)

Aplicar un filtro de "Elemento superior" a la columna para el número de elementos especificado.

applyTopItemsFilter(count: number): void;

Parámetros

count

number

Número de elementos desde la parte superior que se van a mostrar.

Devoluciones

void

applyTopPercentFilter(percent)

Aplicar un filtro de "Porcentaje superior" a la columna para el porcentaje de elementos especificado.

applyTopPercentFilter(percent: number): void;

Parámetros

percent

number

Porcentaje de elementos desde la parte superior que se van a mostrar.

Devoluciones

void

applyValuesFilter(values)

Aplicar un filtro "Valores" a la columna para los valores especificados.

applyValuesFilter(values: Array<string | FilterDatetime>): void;

Parámetros

values

Array<string | ExcelScript.FilterDatetime>

Lista de valores que se va a mostrar. Debe ser una matriz de cadenas o una matriz de ExcelScript.FilterDateTime objetos.

Devoluciones

void

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"]);
}

clear()

Borrar el filtro de la columna especificada.

clear(): void;

Devoluciones

void

Ejemplos

/**
 * This script shows how to clear a filter from a table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Clear the filter for the table column named "Status".
  const statusColumnFilter = table.getColumn("Status").getFilter();
  statusColumnFilter.clear();
}

getCriteria()

Filtro aplicado actualmente en la columna especificada.

getCriteria(): FilterCriteria;

Devoluciones

ExcelScript.FilterCriteria