Excel.Filter class

Referência

Pacote:: excel

Gerencia a filtragem da coluna de uma tabela.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
criteria	O filtro aplicado no momento à coluna fornecida.

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 critérios especificadas.
applyCustomFilter(criteria1, criteria2, operString)	Aplique um filtro "Ícone" à coluna para as cadeias de critérios especificadas.
applyDynamicFilter(criteria)	Aplica um filtro "Dinâmico" à coluna.
applyDynamicFilter(criteriaString)	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 especificado.
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.
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 método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Excel.Filter` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Excel.Interfaces.FilterData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

criteria

O filtro aplicado no momento à coluna fornecida.

readonly criteria: Excel.FilterCriteria;

Valor da propriedade

Excel.FilterCriteria

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, oper)

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

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

[ Conjunto de API: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, operString)

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

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

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

applyDynamicFilter(criteriaString)

Aplica um filtro "Dinâmico" à coluna.

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

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

applyIconFilter(icon)

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

applyIconFilter(icon: Excel.Icon): void;

Parâmetros

icon: Excel.Icon

Os ícones das células a serem mostrados.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

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

[ Conjunto de API: ExcelApi 1.2 ]

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. Tem de ser uma matriz de cadeias ou uma matriz de Excel.FilterDateTime objetos.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

clear()

Limpa o filtro na coluna fornecida.

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: 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(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

Parâmetros

options: Excel.Interfaces.FilterLoadOptions

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

Retornos

Excel.Filter

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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.Filter

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.Filter

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Filter é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.FilterData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.FilterData;

Retornos

Excel.Interfaces.FilterData

Compartilhar via

Excel.Filter class

Comentários

Propriedades

Métodos

Detalhes da propriedade

context

Valor da propriedade

criteria

Valor da propriedade

Comentários

Detalhes do método

apply(criteria)

Parâmetros

Retornos

Comentários

applyBottomItemsFilter(count)

Parâmetros

Retornos

Comentários

applyBottomPercentFilter(percent)

Parâmetros

Retornos

Comentários

applyCellColorFilter(color)

Parâmetros

Retornos

Comentários

applyCustomFilter(criteria1, criteria2, oper)

Parâmetros

Retornos

Comentários

applyCustomFilter(criteria1, criteria2, operString)

Parâmetros

Retornos

Comentários

applyDynamicFilter(criteria)

Parâmetros

Retornos

Comentários

applyDynamicFilter(criteriaString)

Parâmetros

Retornos

Comentários

applyFontColorFilter(color)

Parâmetros

Retornos

Comentários

applyIconFilter(icon)

Parâmetros

Retornos

Comentários

applyTopItemsFilter(count)

Parâmetros

Retornos

Comentários

applyTopPercentFilter(percent)

Parâmetros

Retornos

Comentários

applyValuesFilter(values)

Parâmetros

Retornos

Comentários

clear()

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

load(propertyNamesAndPaths)

Parâmetros

Retornos

toJSON()

Retornos

Recursos adicionais