Excel.Filter class
Gerencia a filtragem da coluna de uma tabela.
- 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. |
Métodos
| apply(criteria) | Aplica os critérios de filtro determinados à coluna fornecida. |
| apply |
Aplica um filtro "Item Inferior" à coluna para obter o número de elementos fornecido. |
| apply |
Aplica um filtro "Percentual Inferior" à coluna para obter a porcentagem de elementos fornecida. |
| apply |
Aplica um filtro "Cor da Célula" à coluna para obter a cor fornecida. |
| apply |
Aplicar um filtro "Ícone" à coluna para as cadeias de caracteres de critérios especificados. |
| apply |
Aplicar um filtro "Ícone" à coluna para as cadeias de caracteres de critérios especificados. |
| apply |
Aplica um filtro "Dinâmico" à coluna. |
| apply |
Aplica um filtro "Dinâmico" à coluna. |
| apply |
Aplica um filtro "Cor da Fonte" à coluna para obter a cor fornecida. |
| apply |
Aplicar um filtro "Ícone" à coluna do ícone fornecido. |
| apply |
Aplica um filtro "Item Superior" à coluna para obter o número de elementos fornecido. |
| apply |
Aplica um filtro "Percentual Superior" à coluna para obter a porcentagem de elementos fornecida. |
| apply |
Aplica um filtro "Valores" à coluna para obter os valores fornecidos. |
| clear() | Limpa o filtro na coluna fornecida. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
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.
readonly criteria: Excel.FilterCriteria;Valor da propriedade
Comentários
Detalhes do método
apply(criteria)
Aplica os critérios de filtro determinados à coluna fornecida.
apply(criteria: Excel.FilterCriteria): void;Parâmetros
- criteria
- Excel.FilterCriteria
O critério a ser aplicado.
Retornos
void
Comentários
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
Comentários
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
Comentários
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
Comentários
applyCustomFilter(criteria1, criteria2, oper)
Aplicar um filtro "Ícone" à coluna para as cadeias de caracteres de critérios especificados.
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
Comentários
applyCustomFilter(criteria1, criteria2, oper)
Aplicar um filtro "Ícone" à coluna para as cadeias de caracteres de critérios especificados.
applyCustomFilter(criteria1: string, criteria2?: string, oper?: "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.
- oper
-
"And" | "Or"
Opcional. O operador que descreve como os dois critérios são unidos.
Retornos
void
Comentários
applyDynamicFilter(criteria)
Aplica um filtro "Dinâmico" à coluna.
applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;Parâmetros
- criteria
- Excel.DynamicFilterCriteria
O critério dinâmico a ser aplicado.
Retornos
void
Comentários
applyDynamicFilter(criteria)
Aplica um filtro "Dinâmico" à coluna.
applyDynamicFilter(criteria: "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
- criteria
-
"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
Comentários
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
Comentários
applyIconFilter(icon)
Aplicar um filtro "Ícone" à coluna do ícone fornecido.
applyIconFilter(icon: Excel.Icon): void;Parâmetros
- icon
- Excel.Icon
Os ícones das células a serem mostrados.
Retornos
void
Comentários
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
Comentários
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
Comentários
applyValuesFilter(values)
Aplica um filtro "Valores" à coluna para obter os valores fornecidos.
applyValuesFilter(values: Array<string | FilterDatetime>): void;Parâmetros
- values
-
Array<string | Excel.FilterDatetime>
A lista de valores a serem mostrados. Deve ser uma matriz de cadeias de caracteres ou uma matriz de Excel.FilterDateTime objetos.
Retornos
void
Comentários
clear()
Limpa o filtro na coluna fornecida.
clear(): void;Retornos
void
Comentários
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
Fornece opções para quais propriedades do objeto devem ser carregadas.
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 especifica 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 método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Filter é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.FilterData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.FilterData;