ExcelScript.Filter interface

Pacote:

ExcelScript

Gerencia a filtragem da coluna de uma tabela.

Comentários

Exemplos

/**
 * 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)	Aplica os critérios de filtro determinados à coluna fornecida.
applyBottomItemsFilter(count)	Aplica um filtro "Item Inferior" à coluna para obter o número de elementos fornecido.
applyBottomPercentFilter(percent)	Aplica um filtro "Percentual Inferior" à coluna para obter a porcentagem de elementos fornecida.
applyCellColorFilter(color)	Aplica um filtro "Cor da Célula" à coluna para obter a cor fornecida.
applyCustomFilter(criteria1, criteria2, oper)	Aplique um filtro "Ícone" à coluna para as cadeias de caracteres de critérios fornecidas.
applyDynamicFilter(criteria)	Aplica um filtro "Dinâmico" à coluna.
applyFontColorFilter(color)	Aplica um filtro "Cor da Fonte" à coluna para obter a cor fornecida.
applyIconFilter(icon)	Aplique um filtro "Ícone" à coluna para o ícone determinado.
applyTopItemsFilter(count)	Aplica um filtro "Item Superior" à coluna para obter o número de elementos fornecido.
applyTopPercentFilter(percent)	Aplica um filtro "Percentual Superior" à coluna para obter a porcentagem de elementos fornecida.
applyValuesFilter(values)	Aplica um filtro "Valores" à coluna para obter os valores fornecidos.
clear()	Limpa o filtro na coluna fornecida.
getCriteria()	O filtro aplicado no momento à coluna fornecida.

Detalhes do método

apply(criteria)

Aplica os critérios de filtro determinados à coluna fornecida.

apply(criteria: FilterCriteria): void;

Parâmetros

criteria

ExcelScript.FilterCriteria

O critério a ser aplicado.

Retornos

void

applyBottomItemsFilter(count)

Aplica um filtro "Item Inferior" à coluna para obter o número de elementos fornecido.

applyBottomItemsFilter(count: number): void;

Parâmetros

count

number

O número de elementos da parte inferior a serem mostrados.

Retornos

void

applyBottomPercentFilter(percent)

Aplica um filtro "Percentual Inferior" à coluna para obter a porcentagem de elementos fornecida.

applyBottomPercentFilter(percent: number): void;

Parâmetros

percent

number

A porcentagem de elementos da parte inferior a serem mostrados.

Retornos

void

applyCellColorFilter(color)

Aplica um filtro "Cor da Célula" à coluna para obter a cor fornecida.

applyCellColorFilter(color: string): void;

Parâmetros

color

string

A cor de tela de fundo das células a serem mostradas.

Retornos

void

applyCustomFilter(criteria1, criteria2, oper)

Aplique um filtro "Ícone" à coluna para as cadeias de caracteres de critérios fornecidas.

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

Parâmetros

criteria1

string

A primeira cadeia de caracteres de critérios.

criteria2

string

Opcional. A segunda cadeia de caracteres de critérios.

oper

ExcelScript.FilterOperator

Opcional. O operador que descreve como os dois critérios são unidos.

Retornos

void

Exemplos

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

Aplica um filtro "Dinâmico" à coluna.

applyDynamicFilter(criteria: DynamicFilterCriteria): void;

Parâmetros

criteria

ExcelScript.DynamicFilterCriteria

O critério dinâmico a ser aplicado.

Retornos

void

Exemplos

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

Aplica um filtro "Cor da Fonte" à coluna para obter a cor fornecida.

applyFontColorFilter(color: string): void;

Parâmetros

color

string

A cor da fonte das células a serem mostradas.

Retornos

void

applyIconFilter(icon)

Aplique um filtro "Ícone" à coluna para o ícone determinado.

applyIconFilter(icon: Icon): void;

Parâmetros

icon

ExcelScript.Icon

Os ícones das células a serem mostrados.

Retornos

void

applyTopItemsFilter(count)

Aplica um filtro "Item Superior" à coluna para obter o número de elementos fornecido.

applyTopItemsFilter(count: number): void;

Parâmetros

count

number

O número de elementos da parte superior a serem mostrados.

Retornos

void

applyTopPercentFilter(percent)

Aplica um filtro "Percentual Superior" à coluna para obter a porcentagem de elementos fornecida.

applyTopPercentFilter(percent: number): void;

Parâmetros

percent

number

A porcentagem de elementos da parte superior a serem mostrados.

Retornos

void

applyValuesFilter(values)

Aplica um filtro "Valores" à coluna para obter os valores fornecidos.

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

Parâmetros

values

Array<string | ExcelScript.FilterDatetime>

A lista de valores a serem mostrados. Isso deve ser uma matriz de cadeias de caracteres ou uma matriz de ExcelScript.FilterDateTime objetos.

Retornos

void

Exemplos

/**
 * 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()

Limpa o filtro na coluna fornecida.

clear(): void;

Retornos

void

Exemplos

/**
 * 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()

O filtro aplicado no momento à coluna fornecida.

getCriteria(): FilterCriteria;

Retornos

ExcelScript.FilterCriteria