ExcelScript.AutoFilter interface
Representa o AutoFilter
objeto . O Filtro Automático transforma os valores na coluna do Excel em filtros específicos com base nos conteúdos das células.
Comentários
Exemplos
/**
* This script creates an autoFilter on the worksheet that filters out rows based on column values.
* The autoFilter filters to only include rows that have a value in column C in the lowest 10 values
* (of column C values).
*/
function main(workbook: ExcelScript.Workbook) {
// Get the autoFilter of the first table in the current worksheet.
const currentSheet = workbook.getActiveWorksheet();
const dataRange = currentSheet.getUsedRange();
const autoFilter = currentSheet.getAutoFilter();
// Add a filter that will only show the rows with the lowest 10 values in column C
// (index 2, assuming the used range spans from at least A:C).
autoFilter.apply(dataRange, 2, {
criterion1: "10",
filterOn: ExcelScript.FilterOn.bottomItems
});
}
Métodos
apply(range, column |
Aplica o AutoFiltro a um intervalo. Isso filtra a coluna se o índice de coluna e os critérios de filtro forem especificados. |
clear |
Limpa os critérios de filtro de coluna do Filtro Automático. |
clear |
Limpa os critérios de filtro e o estado de ordenação do Filtro Automático. |
get |
Uma matriz que contém todos os critérios de filtro no intervalo de autofiltro. |
get |
Especifica se o Filtro Automático está ativado. |
get |
Especifica se o Filtro Automático tem critérios de filtro. |
get |
Devolve o |
reapply() | Aplica o objeto filtro automático especificado atualmente no intervalo. |
remove() | Remove o Filtro automático do intervalo. |
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
-
ExcelScript.Range | string
O intervalo no qual o Filtro Automático será aplicado.
- columnIndex
-
number
O índice de colunas baseado em zero ao qual o Filtro Automático é aplicado.
- criteria
- ExcelScript.FilterCriteria
Os critérios de filtro.
Retornos
void
Exemplos
/**
* This script applies a filter to a table so that
* only rows with values in column 1 that start with "L" are shown.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the autoFilter of the first table in the current worksheet.
const table = workbook.getActiveWorksheet().getTables()[0];
const autoFilter = table.getAutoFilter();
// Filter to only include values that start with "L".
const filterCriteria: ExcelScript.FilterCriteria = {
filterOn: ExcelScript.FilterOn.custom,
criterion1: "L*"
};
// Apply the filter to column 1 (zero-based).
autoFilter.apply(table.getRange(), 1, filterCriteria);
}
clearColumnCriteria(columnIndex)
Limpa os critérios de filtro de coluna do Filtro Automático.
clearColumnCriteria(columnIndex: number): void;
Parâmetros
- columnIndex
-
number
O índice de colunas baseado em zero, que representa o filtro de coluna que tem de ser limpo. Se o valor de índice não for suportado (por exemplo, se o valor for um número negativo ou se o valor for maior do que o número de colunas disponíveis no intervalo), será gerado um InvalidArgument
erro.
Retornos
void
clearCriteria()
Limpa os critérios de filtro e o estado de ordenação do Filtro Automático.
clearCriteria(): void;
Retornos
void
Exemplos
/**
* This script clears any applied criteria from the worksheet's autoFilter.
*/
function main(workbook: ExcelScript.Workbook) {
const currentSheet = workbook.getActiveWorksheet();
// Clear all the criteria currently applied to the autoFilter.
currentSheet.getAutoFilter().clearCriteria();
}
getCriteria()
Uma matriz que contém todos os critérios de filtro no intervalo de autofiltro.
getCriteria(): FilterCriteria[];
Retornos
getEnabled()
Especifica se o Filtro Automático está ativado.
getEnabled(): boolean;
Retornos
boolean
getIsDataFiltered()
Especifica se o Filtro Automático tem critérios de filtro.
getIsDataFiltered(): boolean;
Retornos
boolean
getRange()
Devolve o Range
objeto que representa o intervalo ao qual o Filtro Automático se aplica. Se não existir nenhum Range
objeto associado ao Filtro Automático, este método devolve undefined
.
getRange(): Range;
Retornos
reapply()
Aplica o objeto filtro automático especificado atualmente no intervalo.
reapply(): void;
Retornos
void
remove()
Remove o Filtro automático do intervalo.
remove(): void;
Retornos
void