Partager via

ExcelScript.Filter interface

  • Référence
Paquet:
ExcelScript

Gère le filtrage de la colonne d’un tableau.

Remarques

Exemples

/**
 * This script adds a table filter to only show the top 10% of values 
 * belonging to a particular column.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first table on the current worksheet.
    const table = workbook.getActiveWorksheet().getTables()[0];

    // Get the filter for the "PageViews" table column.
    const pageViewFilter : ExcelScript.Filter = table.getColumnByName("PageViews").getFilter();

    // Apply a filter to only show the rows with the top 10% of values in this column.
    pageViewFilter.applyTopPercentFilter(10);
}

Méthodes

apply(criteria)

Appliquer les critères de filtre donnés à la colonne indiquée.
applyBottomItemsFilter(count)

Appliquer un filtre « Élément inférieur » à la colonne pour le nombre d’éléments donné.
applyBottomPercentFilter(percent)

Appliquer un filtre « Pourcentage inférieur » à la colonne pour le pourcentage d’éléments donné.
applyCellColorFilter(color)

Appliquer un filtre « Couleur de cellule » à la colonne pour la couleur donnée.
applyCustomFilter(criteria1, criteria2, oper)

Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.
applyDynamicFilter(criteria)

Appliquer un filtre « Dynamique » à la colonne.
applyFontColorFilter(color)

Appliquer un filtre « Couleur de police » à la colonne pour la couleur donnée.
applyIconFilter(icon)

Appliquez un filtre « Icône » à la colonne pour l’icône donnée.
applyTopItemsFilter(count)

Appliquer un filtre « Élément supérieur » à la colonne pour le nombre d’éléments donné.
applyTopPercentFilter(percent)

Appliquer un filtre « Pourcentage supérieur » à la colonne pour le pourcentage d’éléments donné.
applyValuesFilter(values)

Appliquer un filtre « Valeurs » à la colonne pour les valeurs données.
clear()

Effacer le filtre sur la colonne donnée.
getCriteria()

Le filtre actuellement appliqué à la colonne donnée.

Détails de la méthode

apply(criteria)

Appliquer les critères de filtre donnés à la colonne indiquée.

apply(criteria: FilterCriteria): void;

Paramètres

criteria
ExcelScript.FilterCriteria

Critères à appliquer.

Retours

void

applyBottomItemsFilter(count)

Appliquer un filtre « Élément inférieur » à la colonne pour le nombre d’éléments donné.

applyBottomItemsFilter(count: number): void;

Paramètres

count

number

Nombre d’éléments à partir du bas à afficher.

Retours

void

applyBottomPercentFilter(percent)

Appliquer un filtre « Pourcentage inférieur » à la colonne pour le pourcentage d’éléments donné.

applyBottomPercentFilter(percent: number): void;

Paramètres

percent

number

Pourcentage d’éléments à partir du bas à afficher.

Retours

void

applyCellColorFilter(color)

Appliquer un filtre « Couleur de cellule » à la colonne pour la couleur donnée.

applyCellColorFilter(color: string): void;

Paramètres

color

string

Couleur d’arrière-plan des cellules à afficher.

Retours

void

applyCustomFilter(criteria1, criteria2, oper)

Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.

applyCustomFilter(
            criteria1: string,
            criteria2?: string,
            oper?: FilterOperator
        ): void;

Paramètres

criteria1

string

Première chaîne de critères.

criteria2

string

Optional. Deuxième chaîne de critères.

oper
ExcelScript.FilterOperator

Optional. Opérateur qui décrit comment les deux critères sont joints.

Retours

void

Exemples

/**
 * The script filters rows from a table based on numerical values.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Filter to only show rows with values in the "Sales" column that are 
  // greater than or equal to 2000.
  table.getColumnByName("Sales").getFilter().applyCustomFilter(">=2000");
}

applyDynamicFilter(criteria)

Appliquer un filtre « Dynamique » à la colonne.

applyDynamicFilter(criteria: DynamicFilterCriteria): void;

Paramètres

criteria
ExcelScript.DynamicFilterCriteria

Critères dynamiques à appliquer.

Retours

void

Exemples

/**
 * This script applies a filter to a table that filters it 
 * to only show rows with dates from the previous month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the table named "ReportTable".
  const table = workbook.getTable("ReportTable");

  // Get the column with the header "Date".
  const dateColumn = table.getColumnByName("Date");

  // Apply a dynamic filter to the column. 
  // `lastMonth` will only show rows with a date from the previous month.
  dateColumn.getFilter().applyDynamicFilter(ExcelScript.DynamicFilterCriteria.lastMonth);
}

applyFontColorFilter(color)

Appliquer un filtre « Couleur de police » à la colonne pour la couleur donnée.

applyFontColorFilter(color: string): void;

Paramètres

color

string

Couleur de police des cellules à afficher.

Retours

void

applyIconFilter(icon)

Appliquez un filtre « Icône » à la colonne pour l’icône donnée.

applyIconFilter(icon: Icon): void;

Paramètres

icon
ExcelScript.Icon

Icônes des cellules à afficher.

Retours

void

applyTopItemsFilter(count)

Appliquer un filtre « Élément supérieur » à la colonne pour le nombre d’éléments donné.

applyTopItemsFilter(count: number): void;

Paramètres

count

number

Nombre d’éléments à partir du haut à afficher.

Retours

void

applyTopPercentFilter(percent)

Appliquer un filtre « Pourcentage supérieur » à la colonne pour le pourcentage d’éléments donné.

applyTopPercentFilter(percent: number): void;

Paramètres

percent

number

Pourcentage d’éléments à partir du haut à afficher.

Retours

void

applyValuesFilter(values)

Appliquer un filtre « Valeurs » à la colonne pour les valeurs données.

applyValuesFilter(values: Array<string | FilterDatetime>): void;

Paramètres

values

Array<string | ExcelScript.FilterDatetime>

Liste des valeurs à afficher. Il doit s’agir d’un tableau de chaînes ou d’un tableau d’objets ExcelScript.FilterDateTime .

Retours

void

Exemples

/**
 * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Apply the filter to the "Type" column.
  const typeColumn = table.getColumnByName("Type");
  typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}

clear()

Effacer le filtre sur la colonne donnée.

clear(): void;

Retours

void

Exemples

/**
 * This script shows how to clear a filter from a table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Clear the filter for the table column named "Status".
  const statusColumnFilter = table.getColumn("Status").getFilter();
  statusColumnFilter.clear();
}

getCriteria()

Le filtre actuellement appliqué à la colonne donnée.

getCriteria(): FilterCriteria;

Retours

ExcelScript.FilterCriteria