ExcelScript.PivotFilters interface
現在特定の PivotField に適用されているすべての PivotFilter を表すインターフェイス。
プロパティ
date |
PivotField の現在適用されている日付フィルター。 このプロパティは、値フィルターが適用されていない場合に |
label |
PivotField の現在適用されているラベル フィルター。 このプロパティは、値フィルターが適用されていない場合に |
manual |
PivotField の現在適用されている手動フィルター。 このプロパティは、値フィルターが適用されていない場合に |
value |
PivotField の現在適用されている値フィルター。 このプロパティは、値フィルターが適用されていない場合に |
プロパティの詳細
dateFilter
PivotField の現在適用されている日付フィルター。 このプロパティは、値フィルターが適用されていない場合に null
されます。
dateFilter?: PivotDateFilter;
プロパティ値
例
/**
* 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
}
});
}
labelFilter
PivotField の現在適用されているラベル フィルター。 このプロパティは、値フィルターが適用されていない場合に null
されます。
labelFilter?: PivotLabelFilter;
プロパティ値
例
/**
* This script filters items that start with "L" from the "Type" field
* of the "Farm Sales" PivotTable.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the PivotTable.
const pivotTable = workbook.getActiveWorksheet().getPivotTable("Farm Sales");
// Get the "Type" field.
const field = pivotTable.getHierarchy("Type").getPivotField("Type");
// Filter out any types that start with "L" (such as "Lemons" and "Limes").
const filter: ExcelScript.PivotLabelFilter = {
condition: ExcelScript.LabelFilterCondition.beginsWith,
substring: "L",
exclusive: true
};
// Apply the label filter to the field.
field.applyFilter({ labelFilter: filter });
}
manualFilter
PivotField の現在適用されている手動フィルター。 このプロパティは、値フィルターが適用されていない場合に null
されます。
manualFilter?: PivotManualFilter;
プロパティ値
例
/**
* This script adds a manual filter to a PivotTable.
*/
function main(workbook: ExcelScript.Workbook)
{
// Get the first PivotTable in the workbook.
const pivot = workbook.getPivotTables()[0];
// Get the hierarchy to use as the filter.
const location = pivot.getHierarchy("Location");
// Use "Location" as the FilterHierarchy.
pivot.addFilterHierarchy(location);
// Select items for the filter.
// Note that hierarchies and fields have a 1:1 relationship in Excel,
// so `getFields()[0]` always gets the correct field.
location.getFields()[0].applyFilter({
manualFilter: {
selectedItems: ["Seattle", "Chicago"]
}
});
}
valueFilter
PivotField の現在適用されている値フィルター。 このプロパティは、値フィルターが適用されていない場合に null
されます。
valueFilter?: PivotValueFilter;
プロパティ値
例
/**
* This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the PivotTable on the current worksheet.
let sheet = workbook.getActiveWorksheet();
let pivotTable = sheet.getPivotTables()[0];
// Get the first row hierarchy to use as the field which gets filtered.
let rowHierarchy = pivotTable.getRowHierarchies()[0];
// Get the first data hierarchy to use as the values for filtering the rows.
let dataHierarchy = pivotTable.getDataHierarchies()[0];
// Create a filter that excludes values greater than 500.
let filter: ExcelScript.PivotValueFilter = {
condition: ExcelScript.ValueFilterCondition.greaterThan,
comparator: 500,
value: dataHierarchy.getName()
};
// Apply the filter.
rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
valueFilter: filter
});
}
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Scripts