ExcelScript.PivotDateFilter interface
Modèle configurable pour un filtre de date à appliquer à un champ croisé dynamique. Définit les condition
critères à définir pour que le filtre fonctionne.
Propriétés
comparator | Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. Le type de comparaison est défini par la condition . |
condition | Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires. |
exclusive | Si |
lower |
Limite inférieure de la plage pour la condition de |
upper |
Limite supérieure de la plage pour la condition de |
whole |
Pour |
Détails de la propriété
comparator
Le comparateur est la valeur statique à laquelle d’autres valeurs sont comparées. Le type de comparaison est défini par la condition .
comparator?: FilterDatetime;
Valeur de propriété
condition
Spécifie la condition du filtre, qui définit les critères de filtrage nécessaires.
condition: DateFilterCondition;
Valeur de propriété
Exemples
/**
* This script applies a filter to a PivotTable that filters out rows
* that aren't from this month.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the "Date Recorded" field to filter.
// The data in this field must be dates in order for the filter to work.
const pivot = workbook.getPivotTables()[0];
const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
const rowField = rowHierarchy.getFields()[0];
// Apply the date filter.
rowField.applyFilter({
dateFilter: {
// Setting the condition to `thisMonth` means items that are before or
// after this month will not be displayed.
condition: ExcelScript.DateFilterCondition.thisMonth
}
});
}
exclusive
Si true
la valeur est , le filtre exclut les éléments qui répondent aux critères. La valeur par défaut est false
(filtre pour inclure les éléments qui répondent aux critères).
exclusive?: boolean;
Valeur de propriété
boolean
lowerBound
Limite inférieure de la plage pour la condition de between
filtre.
lowerBound?: FilterDatetime;
Valeur de propriété
Exemples
/**
* This script applies a filter to a PivotTable that filters it
* to only show rows from between June 20th, 2022 and July 10th, 2022.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the "Date Recorded" field to filter.
// The data in this field must be dates in order for the filter to work.
const pivot = workbook.getPivotTables()[0];
const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
const rowField = rowHierarchy.getFields()[0];
// Create the filter's date boundaries.
let earliestDate: ExcelScript.FilterDatetime = {
date: "2022-06-20",
specificity: ExcelScript.FilterDatetimeSpecificity.day
};
let latestDate: ExcelScript.FilterDatetime = {
date: "2022-07-10",
specificity: ExcelScript.FilterDatetimeSpecificity.day
};
// Apply the date filter.
rowField.applyFilter({
dateFilter: {
condition: ExcelScript.DateFilterCondition.between,
lowerBound: earliestDate,
upperBound: latestDate
}
});
}
upperBound
Limite supérieure de la plage pour la condition de between
filtre.
upperBound?: FilterDatetime;
Valeur de propriété
wholeDays
Pour equals
les conditions de filtre ,before
after
, et between
, indique si des comparaisons doivent être effectuées en tant que jours entiers.
wholeDays?: boolean;
Valeur de propriété
boolean