Excel.AutoFilter interface

Representa o objeto AutoFilter. O AutoFiltro transforma os valores na coluna do Excel em filtros específicos com base no conteúdo da célula.

Propriedades

criteria

Uma matriz que contém todos os critérios de filtro no intervalo de autofiltro.

enabled

Especifica se o AutoFiltro está habilitado.

isDataFiltered

Especifica se o AutoFiltro tem critérios de filtro.

Métodos

apply(range, columnIndex, criteria)

Aplica o AutoFiltro a um intervalo. Isso filtra a coluna se o índice de coluna e os critérios de filtro forem especificados.

clearCriteria()

Limpa os critérios de filtro do AutoFiltro.

getRange()

Retorna um objeto Range que representa o intervalo no qual o Filtro automático se aplica.

getRangeOrNullObject()

Retorna um objeto Range que representa o intervalo no qual o Filtro automático se aplica. Se não houver nenhum objeto Range associado ao AutoFiltro, este método retornará um objeto NULL.

load(propertyNames)

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

reapply()

Aplica o objeto Autofilter especificado que está atualmente no intervalo.

remove()

Remove o Filtro automático do intervalo.

Detalhes da propriedade

criteria

Uma matriz que contém todos os critérios de filtro no intervalo de autofiltro.

readonly criteria: FilterCriteria[];

Valor da propriedade

enabled

Especifica se o AutoFiltro está habilitado.

readonly enabled: boolean;

Valor da propriedade

boolean

isDataFiltered

Especifica se o AutoFiltro tem critérios de filtro.

readonly isDataFiltered: boolean;

Valor da propriedade

boolean

Detalhes do método

apply(range, columnIndex, criteria)

Aplica o AutoFiltro a um intervalo. Isso filtra a coluna se o índice de coluna e os critérios de filtro forem especificados.

apply(
            range: Range | string,
            columnIndex?: number,
            criteria?: FilterCriteria
        ): void;

Parâmetros

range
Range | string

O intervalo no qual o AutoFiltro será aplicado.

columnIndex
number

O índice de coluna com base em zero ao qual o AutoFiltro é aplicado.

criteria
FilterCriteria

Os critérios de filtro.

Retornos

void

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getActiveWorksheet();
    let farmData = sheet.getUsedRange();

    // This filter will only show the rows with the top 25% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, { criterion1: "25", filterOn: Excel.FilterOn.topPercent });
    await context.sync();
}

clearCriteria()

Limpa os critérios de filtro do AutoFiltro.

clearCriteria(): void;

Retornos

void

getRange()

Retorna um objeto Range que representa o intervalo no qual o Filtro automático se aplica.

getRange(): Range;

Retornos

getRangeOrNullObject()

Retorna um objeto Range que representa o intervalo no qual o Filtro automático se aplica. Se não houver nenhum objeto Range associado ao AutoFiltro, este método retornará um objeto NULL.

getRangeOrNullObject(): Range;

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[]): void;

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

void

reapply()

Aplica o objeto Autofilter especificado que está atualmente no intervalo.

reapply(): void;

Retornos

void

remove()

Remove o Filtro automático do intervalo.

remove(): void;

Retornos

void