ExcelScript.AutoFilter interface

Paquet:

ExcelScript

Représente l’objet AutoFilter . Le filtre automatique transforme les valeurs de la colonne Excel en filtres spécifiques en fonction du contenu de la cellule.

Remarques

Exemples

/**
 * 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éthodes

apply(range, columnIndex, criteria)	Applique le filtre automatique à une plage. Ceci permet de filtrer la colonne si les critères de filtre de colonne et index sont spécifiés.
clearColumnCriteria(columnIndex)	Efface les critères de filtre de colonne du filtre automatique.
clearCriteria()	Efface les critères de filtre et l’état de tri du filtre automatique.
getCriteria()	Tableau qui conserve tous les critères de filtre dans une plage filtrée.
getEnabled()	Spécifie si le filtre automatique est activé.
getIsDataFiltered()	Spécifie si le filtre automatique a des critères de filtre.
getRange()	Renvoie l’objet Range qui représente la plage à laquelle le filtre automatique s’applique. Si aucun objet n’est Range associé au filtre automatique, cette méthode retourne undefined.
reapply()	Applique l’objet AutoFilter spécifié actuellement sur la plage.
remove()	Supprime le filtre automatique pour la plage.

Détails de la méthode

apply(range, columnIndex, criteria)

Applique le filtre automatique à une plage. Ceci permet de filtrer la colonne si les critères de filtre de colonne et index sont spécifiés.

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

Paramètres

range

ExcelScript.Range | string

Plage sur laquelle le filtre automatique s’applique.

columnIndex

number

Index de colonne de base zéro auquel le filtre automatique est appliqué.

criteria

ExcelScript.FilterCriteria

Critères de filtre.

Retours

void

Exemples

/**
 * 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)

Efface les critères de filtre de colonne du filtre automatique.

clearColumnCriteria(columnIndex: number): void;

Paramètres

columnIndex

number

Index de colonne de base zéro, qui représente le filtre de colonne à effacer. Si la valeur d’index n’est pas prise en charge (par exemple, si la valeur est un nombre négatif, ou si la valeur est supérieure au nombre de colonnes disponibles dans la plage), une InvalidArgument erreur est générée.

Retours

void

clearCriteria()

Efface les critères de filtre et l’état de tri du filtre automatique.

clearCriteria(): void;

Retours

void

Exemples

/**
 * 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()

Tableau qui conserve tous les critères de filtre dans une plage filtrée.

getCriteria(): FilterCriteria[];

Retours

ExcelScript.FilterCriteria[]

getEnabled()

Spécifie si le filtre automatique est activé.

getEnabled(): boolean;

Retours

boolean

getIsDataFiltered()

Spécifie si le filtre automatique a des critères de filtre.

getIsDataFiltered(): boolean;

Retours

boolean

getRange()

Renvoie l’objet Range qui représente la plage à laquelle le filtre automatique s’applique. Si aucun objet n’est Range associé au filtre automatique, cette méthode retourne undefined.

getRange(): Range;

Retours

ExcelScript.Range

reapply()

Applique l’objet AutoFilter spécifié actuellement sur la plage.

reapply(): void;

Retours

void

remove()

Supprime le filtre automatique pour la plage.

remove(): void;

Retours

void