Excel.Filter class

Gerencia a filtragem da coluna de uma tabela.

[Conjunto de APIs: ExcelApi 1,2]

Extends

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

criteria

O filtro aplicado no momento à coluna fornecida.

[Conjunto de APIs: ExcelApi 1,2]

Métodos

apply(criteria)

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

[Conjunto de APIs: ExcelApi 1,2]

applyBottomItemsFilter(count)

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

[Conjunto de APIs: ExcelApi 1,2]

applyBottomPercentFilter(percent)

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

[Conjunto de APIs: ExcelApi 1,2]

applyCellColorFilter(color)

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

[Conjunto de APIs: ExcelApi 1,2]

applyCustomFilter(criteria1, criteria2, oper)

Aplica um filtro "Icon" à coluna para obter as cadeias de caracteres de critérios fornecidas.

[Conjunto de APIs: ExcelApi 1,2]

applyCustomFilter(criteria1, criteria2, operString)

Aplica um filtro "Icon" à coluna para obter as cadeias de caracteres de critérios fornecidas.

[Conjunto de APIs: ExcelApi 1,2]

applyDynamicFilter(criteria)

Aplica um filtro "Dinâmico" à coluna.

[Conjunto de APIs: ExcelApi 1,2]

applyDynamicFilter(criteriaString)

Aplica um filtro "Dinâmico" à coluna.

[Conjunto de APIs: ExcelApi 1,2]

applyFontColorFilter(color)

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

[Conjunto de APIs: ExcelApi 1,2]

applyIconFilter(icon)

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

[Conjunto de APIs: ExcelApi 1,2]

applyTopItemsFilter(count)

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

[Conjunto de APIs: ExcelApi 1,2]

applyTopPercentFilter(percent)

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

[Conjunto de APIs: ExcelApi 1,2]

applyValuesFilter(values)

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

[Conjunto de APIs: ExcelApi 1,2]

clear()

Limpa o filtro na coluna fornecida.

[Conjunto de APIs: ExcelApi 1,2]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

toJSON()

Substitui o toJSON() método JavaScript para fornecer uma saída mais útil quando um objeto API é passado paraJSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel. Filter original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado comoExcel.Interfaces.FilterData) que contém cópias superficiais de qualquer propriedade filho carregada do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

criteria

O filtro aplicado no momento à coluna fornecida.

[Conjunto de APIs: ExcelApi 1,2]

readonly criteria: Excel.FilterCriteria;

Valor da propriedade

Detalhes do método

apply(criteria)

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

[Conjunto de APIs: ExcelApi 1,2]

apply(criteria: Excel.FilterCriteria): void;

Parâmetros

criteria
Excel.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.

[Conjunto de APIs: ExcelApi 1,2]

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.

[Conjunto de APIs: ExcelApi 1,2]

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.

[Conjunto de APIs: ExcelApi 1,2]

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.

[Conjunto de APIs: ExcelApi 1,2]

applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.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
Excel.FilterOperator

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

Retornos

void

applyCustomFilter(criteria1, criteria2, operString)

Aplica um filtro "Icon" à coluna para obter as cadeias de caracteres de critérios fornecidas.

[Conjunto de APIs: ExcelApi 1,2]

applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;

Parâmetros

criteria1
string

A primeira cadeia de caracteres de critérios.

criteria2
string

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

operString
"And" | "Or"

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

Retornos

void

applyDynamicFilter(criteria)

Aplica um filtro "Dinâmico" à coluna.

[Conjunto de APIs: ExcelApi 1,2]

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

Parâmetros

criteria
Excel.DynamicFilterCriteria

O critério dinâmico a ser aplicado.

Retornos

void

applyDynamicFilter(criteriaString)

Aplica um filtro "Dinâmico" à coluna.

[Conjunto de APIs: ExcelApi 1,2]

applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void;

Parâmetros

criteriaString
"Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

O critério dinâmico a ser aplicado.

Retornos

void

applyFontColorFilter(color)

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

[Conjunto de APIs: ExcelApi 1,2]

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.

[Conjunto de APIs: ExcelApi 1,2]

applyIconFilter(icon: Excel.Icon): void;

Parâmetros

icon
Excel.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.

[Conjunto de APIs: ExcelApi 1,2]

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.

[Conjunto de APIs: ExcelApi 1,2]

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.

[Conjunto de APIs: ExcelApi 1,2]

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 Excel. FilterDateTime.

Retornos

void

clear()

Limpa o filtro na coluna fornecida.

[Conjunto de APIs: ExcelApi 1,2]

clear(): void;

Retornos

void

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

Parâmetros

options
Excel.Interfaces.FilterLoadOptions

Fornece opções para as propriedades do objeto a ser carregado.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.Filter;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Filter;

Parâmetros

propertyNamesAndPaths
{ select?: string; expand?: string; }

propertyNamesAndPaths.selecté uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

toJSON()

Substitui o toJSON() método JavaScript para fornecer uma saída mais útil quando um objeto API é passado paraJSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel. Filter original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado comoExcel.Interfaces.FilterData) que contém cópias superficiais de qualquer propriedade filho carregada do objeto original.

toJSON(): Excel.Interfaces.FilterData;

Retornos