Share via

Excel.AutoFilter class

  • Referência
Pacote:
excel

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

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

context

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

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

Especifica se o AutoFilter está habilitado.
isDataFiltered

Especifica se o AutoFilter 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.
clearColumnCriteria(columnIndex)

Limpa os critérios de filtro de coluna do AutoFilter.
clearCriteria()

Limpa os critérios de filtro e o estado de classificação do AutoFilter.
getRange()

Retorna o Range objeto que representa o intervalo ao qual o AutoFilter se aplica.
getRangeOrNullObject()

Retorna o Range objeto que representa o intervalo ao qual o AutoFilter se aplica. Se não houver nenhum Range objeto associado ao AutoFilter, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
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.
reapply()

Aplica o objeto AutoFilter especificado atualmente no intervalo.
remove()

Remove o Filtro automático do intervalo.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.AutoFilter original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.AutoFilterData) que contém cópias rasas de quaisquer propriedades filho carregadas 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

Excel.RequestContext

criteria

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

readonly criteria: Excel.FilterCriteria[];

Valor da propriedade

Excel.FilterCriteria[]

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

enabled

Especifica se o AutoFilter está habilitado.

readonly enabled: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

isDataFiltered

Especifica se o AutoFilter tem critérios de filtro.

readonly isDataFiltered: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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?: Excel.FilterCriteria): void;

Parâmetros

range

Excel.Range | string

O intervalo no qual o AutoFilter será aplicado.

columnIndex

number

O índice de coluna baseado em zero ao qual o AutoFilter é aplicado.

criteria
Excel.FilterCriteria

Os critérios de filtro.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

clearColumnCriteria(columnIndex)

Limpa os critérios de filtro de coluna do AutoFilter.

clearColumnCriteria(columnIndex: number): void;

Parâmetros

columnIndex

number

O índice de coluna baseado em zero, que representa qual filtro de coluna precisa ser limpo. Se o valor do índice não tiver suporte (por exemplo, se o valor for um número negativo ou se o valor for maior que o número de colunas disponíveis no intervalo), um InvalidArgument erro será gerado.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function clears the AutoFilter setting from one column.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Clear the filter from only column 3.
    sheet.autoFilter.clearColumnCriteria(3);
    await context.sync();
});

clearCriteria()

Limpa os critérios de filtro e o estado de classificação do AutoFilter.

clearCriteria(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getRange()

Retorna o Range objeto que representa o intervalo ao qual o AutoFilter se aplica.

getRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getRangeOrNullObject()

Retorna o Range objeto que representa o intervalo ao qual o AutoFilter se aplica. Se não houver nenhum Range objeto associado ao AutoFilter, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getRangeOrNullObject(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.AutoFilterLoadOptions): Excel.AutoFilter;

Parâmetros

options
Excel.Interfaces.AutoFilterLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.AutoFilter

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.AutoFilter;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.AutoFilter

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.AutoFilter;

Parâmetros

propertyNamesAndPaths

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

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

Retornos

Excel.AutoFilter

reapply()

Aplica o objeto AutoFilter especificado atualmente no intervalo.

reapply(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function refreshes the AutoFilter to ensure that changes are captured.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Reapply the filter to capture changes.
    sheet.autoFilter.reapply();
    await context.sync();
});

remove()

Remove o Filtro automático do intervalo.

remove(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function removes all AutoFilters from the active worksheet.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Remove all filters.
    sheet.autoFilter.remove();
    await context.sync();
});

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.AutoFilter original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.AutoFilterData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.AutoFilterData;

Retornos

Excel.Interfaces.AutoFilterData