Excel.AutoFilter class

  • Référence
Paquet:
excel

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.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
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)

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.
getRange()

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

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 un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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 toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.AutoFilter d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (typé en tant Excel.Interfaces.AutoFilterDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

criteria

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

readonly criteria: Excel.FilterCriteria[];

Valeur de propriété

Excel.FilterCriteria[]

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 sur laquelle le filtre automatique s’applique.

columnIndex

number

Index de colonne de base zéro 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

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

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

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

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

Efface 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 Range qui représente la plage à laquelle le filtre automatique s’applique.

getRange(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getRangeOrNullObject()

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 un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getRangeOrNullObject(): Excel.Range;

Retours

Excel.Range

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 les propriétés de l’objet à charger.

Retours

Excel.AutoFilter

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 qui spécifient les propriétés à charger.

Retours

Excel.AutoFilter

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 propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.AutoFilter

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

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

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

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

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.AutoFilter d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (typé en tant Excel.Interfaces.AutoFilterDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.AutoFilterData;

Retours

Excel.Interfaces.AutoFilterData