Excel.PivotField class
Représente le champ croisé dynamique Excel.
- Extends
Remarques
Utilisateur
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| id | ID du champ de tableau croisé dynamique. |
| items | Renvoie les éléments croisés dynamiques associés au champ croisé dynamique. |
| name | Nom du champ PivotField. |
| show |
Détermine si vous voulez afficher tous les éléments de PivotField. |
| subtotals | Sous-totaux du champ PivotField. |
Méthodes
| apply |
Définit un ou plusieurs des filtres croisés dynamiques actuels du champ et les applique au champ. Si les filtres fournis ne sont pas valides ou ne peuvent pas être appliqués, une exception est levée. |
| clear |
Efface tous les critères de tous les filtres du champ. Cela supprime tout filtrage actif sur le champ. |
| clear |
Efface tous les critères existants du filtre du champ du type donné (s’il est actuellement appliqué). |
| clear |
Efface tous les critères existants du filtre du champ du type donné (s’il est actuellement appliqué). |
| get |
Récupère tous les filtres actuellement appliqués sur le champ. |
| is |
Vérifie si des filtres sont appliqués sur le champ. |
| is |
Vérifie si des filtres sont appliqués sur le champ. |
| 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 |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| sort |
Trie le PivotField. Si une DataPivotHierarchy est spécifiée, le tri sera appliqué en fonction de celle-ci, sinon le tri sera basé sur le PivotField lui-même. |
| sort |
Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques à utiliser pour trier lorsque plusieurs valeurs proviennent de la même DataPivotHierarchy. |
| sort |
Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques à utiliser pour trier lorsque plusieurs valeurs proviennent de la même DataPivotHierarchy. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
id
ID du champ de tableau croisé dynamique.
readonly id: string;Valeur de propriété
string
Remarques
items
Renvoie les éléments croisés dynamiques associés au champ croisé dynamique.
readonly items: Excel.PivotItemCollection;Valeur de propriété
Remarques
name
Nom du champ PivotField.
name: string;Valeur de propriété
string
Remarques
showAllItems
Détermine si vous voulez afficher tous les éléments de PivotField.
showAllItems: boolean;Valeur de propriété
boolean
Remarques
subtotals
Sous-totaux du champ PivotField.
subtotals: Excel.Subtotals;Valeur de propriété
Remarques
Détails de la méthode
applyFilter(filter)
Définit un ou plusieurs des filtres croisés dynamiques actuels du champ et les applique au champ. Si les filtres fournis ne sont pas valides ou ne peuvent pas être appliqués, une exception est levée.
applyFilter(filter: Excel.PivotFilters): void;Paramètres
- filter
- Excel.PivotFilters
Un filtre croisé dynamique spécifique configuré, ou une interface de filtres croisés dynamiques contenant plusieurs filtres configurés.
Retours
void
Remarques
clearAllFilters()
Efface tous les critères de tous les filtres du champ. Cela supprime tout filtrage actif sur le champ.
clearAllFilters(): void;Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml
await Excel.run(async (context) => {
// Clear all the PivotFilters.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
pivotTable.hierarchies.load("name");
await context.sync();
// Clear the filters on each PivotField.
pivotTable.hierarchies.items.forEach((hierarchy) => {
hierarchy.fields.getItem(hierarchy.name).clearAllFilters();
});
await context.sync();
});
clearFilter(filterType)
Efface tous les critères existants du filtre du champ du type donné (s’il est actuellement appliqué).
clearFilter(filterType: Excel.PivotFilterType): void;Paramètres
- filterType
- Excel.PivotFilterType
Type de filtre dans le champ dont tous les critères doivent être effacés.
Retours
void
Remarques
clearFilter(filterType)
Efface tous les critères existants du filtre du champ du type donné (s’il est actuellement appliqué).
clearFilter(filterType: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;Paramètres
- filterType
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Type de filtre dans le champ dont tous les critères doivent être effacés.
Retours
void
Remarques
getFilters()
Récupère tous les filtres actuellement appliqués sur le champ.
getFilters(): OfficeExtension.ClientResult<Excel.PivotFilters>;Retours
Interface PivotFilters avec tous les filtres actifs.
Remarques
isFiltered(filterType)
Vérifie si des filtres sont appliqués sur le champ.
isFiltered(filterType?: Excel.PivotFilterType): OfficeExtension.ClientResult<boolean>;Paramètres
- filterType
- Excel.PivotFilterType
Type de filtre à case activée. Si aucun type n’est fourni, cette méthode case activée si un filtre est appliqué.
Retours
OfficeExtension.ClientResult<boolean>
True si un filtre de type filterType est appliqué au champ. Si filterType n’est pas spécifié, true est retourné si des filtres sont appliqués au champ.
Remarques
isFiltered(filterType)
Vérifie si des filtres sont appliqués sur le champ.
isFiltered(filterType?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;Paramètres
- filterType
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Type de filtre à case activée. Si aucun type n’est fourni, cette méthode case activée si un filtre est appliqué.
Retours
OfficeExtension.ClientResult<boolean>
True si un filtre de type filterType est appliqué au champ. Si filterType n’est pas spécifié, true est retourné si des filtres sont appliqués au champ.
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.PivotFieldLoadOptions): Excel.PivotField;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.PivotField;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.PivotField;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
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.PivotFieldUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Excel.PivotField): void;Paramètres
- properties
- Excel.PivotField
Retours
void
sortByLabels(sortBy)
Trie le PivotField. Si une DataPivotHierarchy est spécifiée, le tri sera appliqué en fonction de celle-ci, sinon le tri sera basé sur le PivotField lui-même.
sortByLabels(sortBy: SortBy): void;Paramètres
- sortBy
- Excel.SortBy
Spécifie si le tri est effectué dans l’ordre croissant ou décroissant.
Retours
void
Remarques
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques à utiliser pour trier lorsque plusieurs valeurs proviennent de la même DataPivotHierarchy.
sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Paramètres
- sortBy
- Excel.SortBy
Spécifie si le tri est effectué dans l’ordre croissant ou décroissant.
- valuesHierarchy
- Excel.DataPivotHierarchy
Spécifie la hiérarchie des valeurs sur l’axe des données à utiliser pour le tri.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Les éléments qui doivent être utilisés pour l’étendue du tri. Il s’agit des éléments qui composent la ligne ou la colonne sur laquelle effectuer le tri. Si une chaîne est utilisée au lieu d’un élément croisé dynamique, la chaîne représente l’ID de l’élément croisé dynamique. S’il n’y a pas d’éléments autres que la hiérarchie des données sur l’axe sur lequel effectuer le tri, il peut être vide.
Retours
void
Remarques
sortByValues(sortBy, valuesHierarchy, pivotItemScope)
Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques à utiliser pour trier lorsque plusieurs valeurs proviennent de la même DataPivotHierarchy.
sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Paramètres
- sortBy
-
"Ascending" | "Descending"
Spécifie si le tri est effectué dans l’ordre croissant ou décroissant.
- valuesHierarchy
- Excel.DataPivotHierarchy
Spécifie la hiérarchie des valeurs sur l’axe des données à utiliser pour le tri.
- pivotItemScope
-
Array<Excel.PivotItem | string>
Les éléments qui doivent être utilisés pour l’étendue du tri. Il s’agit des éléments qui composent la ligne ou la colonne sur laquelle effectuer le tri. Si une chaîne est utilisée au lieu d’un élément croisé dynamique, la chaîne représente l’ID de l’élément croisé dynamique. S’il n’y a pas d’éléments autres que la hiérarchie des données sur l’axe sur lequel effectuer le tri, il peut être vide.
Retours
void
Remarques
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.PivotField est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PivotFieldDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.PivotFieldData;