ExcelScript.Filter interface

Gerencia a filtragem da coluna de uma tabela.

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)

Aplica um filtro "Icon" à coluna para obter 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)

Aplicar um filtro "ícone" à coluna para o ícone dado.

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

Aplica um filtro "Icon" à coluna para obter 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
FilterOperator

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

Retornos

void

applyDynamicFilter(criteria)

Aplica um filtro "Dinâmico" à coluna.

applyDynamicFilter(criteria: DynamicFilterCriteria): void;

Parâmetros

criteria
DynamicFilterCriteria

O critério dinâmico a ser aplicado.

Retornos

void

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)

Aplicar um filtro "ícone" à coluna para o ícone dado.

applyIconFilter(icon: Icon): void;

Parâmetros

icon
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 | FilterDatetime>

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

Retornos

void

clear()

Limpa o filtro na coluna fornecida.

clear(): void;

Retornos

void

getCriteria()

O filtro aplicado no momento à coluna fornecida.

getCriteria(): FilterCriteria;

Retornos