Excel.PivotFilters interface
Interface représentant tous les filtres croisés dynamiques actuellement appliqués à un champ de tableau croisé dynamique donné.
Remarques
[ Ensemble d’API : ExcelApi 1.12 ]
Propriétés
date |
Filtre de date actuellement appliqué du champ de tableau croisé dynamique. Cette propriété est |
label |
Filtre d’étiquettes actuellement appliqué à PivotField. Cette propriété est |
manual |
Filtre manuel actuellement appliqué au champ croisé dynamique. Cette propriété est |
value |
Filtre de valeurs actuellement appliqué au champ croisé dynamique. Cette propriété est |
Détails de la propriété
dateFilter
Filtre de date actuellement appliqué du champ de tableau croisé dynamique. Cette propriété est null
si aucun filtre de valeur n’est appliqué.
dateFilter?: Excel.PivotDateFilter;
Valeur de propriété
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) => {
// Add a date-based PivotFilter.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// PivotFilters can only be applied to PivotHierarchies that are being used for pivoting.
// If it's not already there, add "Date Updated" to the hierarchies.
let dateHierarchy = pivotTable.rowHierarchies.getItemOrNullObject("Date Updated");
await context.sync();
if (dateHierarchy.isNullObject) {
dateHierarchy = pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Date Updated"));
}
// Apply a date filter to filter out anything logged before August.
const filterField = dateHierarchy.fields.getItem("Date Updated");
const dateFilter = {
condition: Excel.DateFilterCondition.afterOrEqualTo,
comparator: {
date: "2020-08-01",
specificity: Excel.FilterDatetimeSpecificity.month
}
};
filterField.applyFilter({ dateFilter: dateFilter });
await context.sync();
});
labelFilter
Filtre d’étiquettes actuellement appliqué à PivotField. Cette propriété est null
si aucun filtre de valeur n’est appliqué.
labelFilter?: Excel.PivotLabelFilter;
Valeur de propriété
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) => {
// Add a PivotFilter to filter based on the strings of item labels.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// Get the "Type" field.
const field = pivotTable.hierarchies.getItem("Type").fields.getItem("Type");
// Filter out any types that start with "L" ("Lemons" and "Limes" in this case).
const filter: Excel.PivotLabelFilter = {
condition: Excel.LabelFilterCondition.beginsWith,
substring: "L",
exclusive: true
};
// Apply the label filter to the field.
field.applyFilter({ labelFilter: filter });
await context.sync();
});
manualFilter
Filtre manuel actuellement appliqué au champ croisé dynamique. Cette propriété est null
si aucun filtre de valeur n’est appliqué.
manualFilter?: Excel.PivotManualFilter;
Valeur de propriété
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) => {
// Add a PivotFilter to filter on manually-selected items.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// PivotFilters can only be applied to PivotHierarchies that are being used for pivoting.
// If it's not already there, add "Classification" to the hierarchies.
let classHierarchy = pivotTable.filterHierarchies.getItemOrNullObject("Classification");
await context.sync();
if (classHierarchy.isNullObject) {
classHierarchy = pivotTable.filterHierarchies.add(pivotTable.hierarchies.getItem("Classification"));
}
// Apply a manual filter to include only a specific PivotItem (the string "Organic").
const filterField = classHierarchy.fields.getItem("Classification");
const manualFilter = { selectedItems: ["Organic"]};
filterField.applyFilter({ manualFilter: manualFilter });
await context.sync();
});
valueFilter
Filtre de valeurs actuellement appliqué au champ croisé dynamique. Cette propriété est null
si aucun filtre de valeur n’est appliqué.
valueFilter?: Excel.PivotValueFilter;
Valeur de propriété
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) => {
// Add a PivotFilter to filter on the values correlated with a row.
// Get the PivotTable.
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// Get the "Farm" field.
const field = pivotTable.hierarchies.getItem("Farm").fields.getItem("Farm");
// Filter to only include rows with more than 500 wholesale crates sold.
const filter: Excel.PivotValueFilter = {
condition: Excel.ValueFilterCondition.greaterThan,
comparator: 500,
value: "Sum of Crates Sold Wholesale"
};
// Apply the value filter to the field.
field.applyFilter({ valueFilter: filter });
await context.sync();
});
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour