Excel.Filter class
Gère le filtrage de la colonne d’un tableau.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.2 ]
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 | Le filtre actuellement appliqué à la colonne donnée. |
Méthodes
apply(criteria) | Appliquer les critères de filtre donnés à la colonne indiquée. |
apply |
Appliquer un filtre « Élément inférieur » à la colonne pour le nombre d’éléments donné. |
apply |
Appliquer un filtre « Pourcentage inférieur » à la colonne pour le pourcentage d’éléments donné. |
apply |
Appliquer un filtre « Couleur de cellule » à la colonne pour la couleur donnée. |
apply |
Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données. |
apply |
Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données. |
apply |
Appliquer un filtre « Dynamique » à la colonne. |
apply |
Appliquer un filtre « Dynamique » à la colonne. |
apply |
Appliquer un filtre « Couleur de police » à la colonne pour la couleur donnée. |
apply |
Appliquez un filtre « Icône » à la colonne pour l’icône donnée. |
apply |
Appliquer un filtre « Élément supérieur » à la colonne pour le nombre d’éléments donné. |
apply |
Appliquer un filtre « Pourcentage supérieur » à la colonne pour le pourcentage d’éléments donné. |
apply |
Appliquer un filtre « Valeurs » à la colonne pour les valeurs données. |
clear() | Effacer le filtre sur la colonne donnée. |
load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
toJSON() | Remplace la méthode JavaScript |
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é
criteria
Le filtre actuellement appliqué à la colonne donnée.
readonly criteria: Excel.FilterCriteria;
Valeur de propriété
Remarques
Détails de la méthode
apply(criteria)
Appliquer les critères de filtre donnés à la colonne indiquée.
apply(criteria: Excel.FilterCriteria): void;
Paramètres
- criteria
- Excel.FilterCriteria
Critères à appliquer.
Retours
void
Remarques
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
Remarques
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
Remarques
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
Remarques
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?: Excel.FilterOperator): void;
Paramètres
- criteria1
-
string
Première chaîne de critères.
- criteria2
-
string
Facultatif. Deuxième chaîne de critères.
- oper
- Excel.FilterOperator
Facultatif. Opérateur qui décrit comment les deux critères sont joints.
Retours
void
Remarques
applyCustomFilter(criteria1, criteria2, operString)
Appliquez un filtre « Icon » à la colonne pour les chaînes de critères données.
applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;
Paramètres
- criteria1
-
string
Première chaîne de critères.
- criteria2
-
string
Facultatif. Deuxième chaîne de critères.
- operString
-
"And" | "Or"
Facultatif. Opérateur qui décrit comment les deux critères sont joints.
Retours
void
Remarques
applyDynamicFilter(criteria)
Appliquer un filtre « Dynamique » à la colonne.
applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;
Paramètres
- criteria
- Excel.DynamicFilterCriteria
Critères dynamiques à appliquer.
Retours
void
Remarques
applyDynamicFilter(criteriaString)
Appliquer un filtre « Dynamique » à la colonne.
applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void;
Paramètres
- criteriaString
-
"Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"
Critères dynamiques à appliquer.
Retours
void
Remarques
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
Remarques
applyIconFilter(icon)
Appliquez un filtre « Icône » à la colonne pour l’icône donnée.
applyIconFilter(icon: Excel.Icon): void;
Paramètres
- icon
- Excel.Icon
Icônes des cellules à afficher.
Retours
void
Remarques
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
Remarques
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
Remarques
applyValuesFilter(values)
Appliquer un filtre « Valeurs » à la colonne pour les valeurs données.
applyValuesFilter(values: Array<string | FilterDatetime>): void;
Paramètres
- values
-
Array<string | Excel.FilterDatetime>
Liste des valeurs à afficher. Il doit s’agir d’un tableau de chaînes ou d’un tableau d’objets Excel.FilterDateTime
.
Retours
void
Remarques
clear()
Effacer le filtre sur la colonne donnée.
clear(): void;
Retours
void
Remarques
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.FilterLoadOptions): Excel.Filter;
Paramètres
Fournit des options pour 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.Filter;
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
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.Filter;
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
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
, à son tour, appelle la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Filter
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.FilterData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.FilterData;