Excel.PivotValueFilter interface
PivotField に適用する値フィルターの構成可能なテンプレート。
conditionは、フィルターを動作させるために設定する必要がある条件を定義します。
注釈
例
// 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();
});
プロパティ
| comparator | コンパレータは、他の値が比較される静的な値です。 比較の種類は条件によって定義されます。 たとえば、コンパレータが "50" で条件が "greaterThan" の場合、50 を超えないすべての項目値がフィルターによって削除されます。 |
| condition | 必要なフィルター条件を定義するフィルターの条件を指定します。 |
| exclusive |
|
| lower |
|
| selection |
フィルターが上位/下位 N 個の項目、上位/下位 N%、または上位/下位の N 個の合計を対象とするかどうかを指定します。 |
| threshold | 上位/下位のフィルター条件に対してフィルター処理される項目数、パーセント数、または合計の "N" しきい値。 |
| upper |
|
| value | フィルター処理するフィールドで選択した "値" の名前。 |
プロパティの詳細
comparator
コンパレータは、他の値が比較される静的な値です。 比較の種類は条件によって定義されます。 たとえば、コンパレータが "50" で条件が "greaterThan" の場合、50 を超えないすべての項目値がフィルターによって削除されます。
comparator?: number;プロパティ値
number
注釈
condition
必要なフィルター条件を定義するフィルターの条件を指定します。
condition: Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN";プロパティ値
Excel.ValueFilterCondition | "Unknown" | "Equals" | "GreaterThan" | "GreaterThanOrEqualTo" | "LessThan" | "LessThanOrEqualTo" | "Between" | "TopN" | "BottomN"
注釈
exclusive
true
場合、フィルターは条件を満たす項目を除外します。 既定値は false です (条件を満たす項目を含むようにフィルター処理します)。
exclusive?: boolean;プロパティ値
boolean
注釈
lowerBound
selectionType
フィルターが上位/下位 N 個の項目、上位/下位 N%、または上位/下位の N 個の合計を対象とするかどうかを指定します。
selectionType?: Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum";プロパティ値
Excel.TopBottomSelectionType | "Items" | "Percent" | "Sum"
注釈
threshold
上位/下位のフィルター条件に対してフィルター処理される項目数、パーセント数、または合計の "N" しきい値。
threshold?: number;プロパティ値
number