Excel.AutoFilter class

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

Extends

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Propriétés

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

criteria

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

enabled

Spécifie si le filtre automatique est activé.

isDataFiltered

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

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)

Cette fonction permet d’effacer les critères de filtrage des colonnes du filtre automatique.

clearCriteria()

Cette fonction permet d’effacer les critères de filtre et l’état de tri du filtre automatique.

getRange()

Renvoie l’objet qui représente la plage à laquelle le filtre automatique Range s’applique.

getRangeOrNullObject()

Renvoie l’objet qui représente la plage à laquelle le filtre automatique Range s’applique. Si aucun objet n’est associé au filtre automatique, cette méthode renvoie un objet dont la propriété Range isNullObject est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

reapply()

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

remove()

Supprime le filtre automatique pour la plage.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. L’objet AutoFilter est un objet API, la méthode renvoie un toJSON objet JavaScript simple (tapé sous la formeExcel.Interfaces.AutoFilterData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

criteria

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

readonly criteria: Excel.FilterCriteria[];

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

enabled

Spécifie si le filtre automatique est activé.

readonly enabled: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

isDataFiltered

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

readonly isDataFiltered: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

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

Paramètres

range

Excel.Range | string

Plage à laquelle le filtre automatique s’appliquera.

columnIndex

number

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

criteria
Excel.FilterCriteria

Critères de filtre.

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
await Excel.run(async (context) => {
    // This method adds a percentage AutoFilter to the active worksheet 
    // and applies the filter to a column of the used range.

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

Cette fonction permet d’effacer les critères de filtrage des colonnes du filtre automatique.

clearColumnCriteria(columnIndex: number): void;

Paramètres

columnIndex

number

Index de colonne de base 0, qui représente le filtre de colonne à effacé. 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 exception est InvalidArgument lancée.

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.14 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
await Excel.run(async (context) => {
    // This method clears the AutoFilter setting from one column.

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

Cette fonction permet d’effacer les critères de filtre et l’état de tri du filtre automatique.

clearCriteria(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getRange()

Renvoie l’objet qui représente la plage à laquelle le filtre automatique Range s’applique.

getRange(): Excel.Range;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getRangeOrNullObject()

Renvoie l’objet qui représente la plage à laquelle le filtre automatique Range s’applique. Si aucun objet n’est associé au filtre automatique, cette méthode renvoie un objet dont la propriété Range isNullObject est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getRangeOrNullObject(): Excel.Range;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter;

Paramètres

options
Excel.Interfaces.AutoFilterLoadOptions

Fournit des options pour lesquelles les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.AutoFilter;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.AutoFilter;

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

reapply()

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

reapply(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
await Excel.run(async (context) => {
    // This method refreshes the AutoFilter to ensure that changes are captured.

    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

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

remove()

Supprime le filtre automatique pour la plage.

remove(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
await Excel.run(async (context) => {
    // This method removes all AutoFilters from the active worksheet.

    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

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

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. L’objet AutoFilter est un objet API, la méthode renvoie un toJSON objet JavaScript simple (tapé sous la formeExcel.Interfaces.AutoFilterData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.AutoFilterData;

Retours