Excel.PivotField class
Représente le champ de tableau croisé dynamique Excel.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.8 ]
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. |
| id | ID du champ de tableau croisé dynamique. |
| items | Renvoie les pivotItems associés au champ de tableau 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 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é (le cas échéant). |
| clear |
Efface tous les critères existants du filtre du champ du type donné (le cas échéant). |
| get |
Obtient tous les filtres actuellement appliqués sur le champ. |
| is |
Vérifie s’il existe des filtres appliqués sur le champ. |
| is |
Vérifie s’il existe des filtres 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 passer un objet brut avec les propriétés appropriées ou 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 qui seront utilisées pour trier lorsqu’il existe plusieurs valeurs à partir du 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 qui seront utilisées pour trier lorsqu’il existe plusieurs valeurs à partir du même DataPivotHierarchy. |
| 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é
id
ID du champ de tableau croisé dynamique.
readonly id: string;Valeur de propriété
string
Remarques
items
Renvoie les pivotItems associés au champ de tableau 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 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 PivotFilter spécifique configuré ou une interface PivotFilters 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
[ Ensemble d’API : ExcelApi 1.12 ]
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é (le cas échéant).
clearFilter(filterType: Excel.PivotFilterType): void;Paramètres
- filterType
- Excel.PivotFilterType
Type de filtre sur le champ dont tous les critères doivent être effacés.
Retours
void
Remarques
clearFilter(filterTypeString)
Efface tous les critères existants du filtre du champ du type donné (le cas échéant).
clearFilter(filterTypeString: "Unknown" | "Value" | "Manual" | "Label" | "Date"): void;Paramètres
- filterTypeString
-
"Unknown" | "Value" | "Manual" | "Label" | "Date"
Type de filtre sur le champ dont tous les critères doivent être effacés.
Retours
void
Remarques
getFilters()
Obtient 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 s’il existe des filtres 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 le champ a des filtres appliqués.
Remarques
isFiltered(filterTypeString)
Vérifie s’il existe des filtres appliqués sur le champ.
isFiltered(filterTypeString?: "Unknown" | "Value" | "Manual" | "Label" | "Date"): OfficeExtension.ClientResult<boolean>;Paramètres
- filterTypeString
-
"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 le champ a des filtres appliqués.
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 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.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 passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.PivotFieldUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.PivotFieldUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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 qui seront utilisées pour trier lorsqu’il existe plusieurs valeurs à partir du 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>
Éléments à utiliser pour l’étendue du tri. Il s’agit des éléments qui composent la ligne ou la colonne sur laquelle vous souhaitez trier. Si une chaîne est utilisée à la place d’un pivotItem, la chaîne représente l’ID de l’objet PivotItem. S’il n’y a pas d’éléments autres que la hiérarchie de données sur l’axe sur lequel vous souhaitez trier, cela peut être vide.
Retours
void
Remarques
sortByValues(sortByString, valuesHierarchy, pivotItemScope)
Trie le PivotField par valeurs spécifiées dans une étendue donnée. L’étendue définit les valeurs spécifiques qui seront utilisées pour trier lorsqu’il existe plusieurs valeurs à partir du même DataPivotHierarchy.
sortByValues(sortByString: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;Paramètres
- sortByString
-
"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>
Éléments à utiliser pour l’étendue du tri. Il s’agit des éléments qui composent la ligne ou la colonne sur laquelle vous souhaitez trier. Si une chaîne est utilisée à la place d’un pivotItem, la chaîne représente l’ID de l’objet PivotItem. S’il n’y a pas d’éléments autres que la hiérarchie de données sur l’axe sur lequel vous souhaitez trier, cela 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.PivotFieldDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.PivotFieldData;