ExcelScript.FilterCriteria interface
列に適用するフィルター条件を表します。
プロパティ
color | セルをフィルター処理するために使用する HTML カラー文字列。
|
criterion1 | データをフィルター処理するために使用する最初の条件。 フィルター処理の場合は、演算子 上位/下位項目/パーセントの場合の数値として使用されます (たとえば、 |
criterion2 | データをフィルター処理するために使用する 2 番目の条件。
|
dynamic |
この列に適用するように設定 |
filter |
値を表示する必要があるかどうかを判断するためにフィルターによって使用されるプロパティ。 |
icon | セルをフィルター処理するために使用するアイコン。
|
operator | フィルター処理を使用する場合に条件 1 と 2 を結合するために使用 |
sub |
リッチ値に対してリッチ フィルターを実行するためにフィルターによって使用されるプロパティ。 |
values | フィルター処理の一部として使用する値のセット |
プロパティの詳細
color
セルをフィルター処理するために使用する HTML カラー文字列。
cellColor
およびfontColor
フィルター処理で使用されます。
color?: string;
プロパティ値
string
criterion1
データをフィルター処理するために使用する最初の条件。 フィルター処理の場合は、演算子 custom
使用されます。 たとえば、50 を超える数値の場合は ">50"、"s" で終わる値の場合は "=*s" などです。
上位/下位項目/パーセントの場合の数値として使用されます (たとえば、 filterOn
が topItems
に設定されている場合、上位 5 項目の "5" など)。
criterion1?: string;
プロパティ値
string
例
/**
* This script creates an autoFilter on the worksheet that filters out rows based on column values.
* The autoFilter filters to only include rows that have a value in column C in the lowest 10 values
* (of column C values).
*/
function main(workbook: ExcelScript.Workbook) {
const currentSheet = workbook.getActiveWorksheet();
const dataRange = currentSheet.getUsedRange();
// Add a filter that will only show the rows with the lowest 10 values in column C
// (index 2, assuming the used range spans from at least A:C).
const filterCriteria: ExcelScript.FilterCriteria = {
criterion1: "10",
filterOn: ExcelScript.FilterOn.bottomItems
};
currentSheet.getAutoFilter().apply(dataRange, 2, filterCriteria);
}
criterion2
データをフィルター処理するために使用する 2 番目の条件。
custom
フィルター処理の場合にのみ演算子として使用されます。
criterion2?: string;
プロパティ値
string
dynamicCriteria
この列に適用するように設定 ExcelScript.DynamicFilterCriteria
からの動的条件。
dynamic
フィルター処理で使用されます。
dynamicCriteria?: DynamicFilterCriteria;
プロパティ値
filterOn
icon
operator
フィルター処理を使用する場合に条件 1 と 2 を結合するために使用 custom
演算子。
operator?: FilterOperator;
プロパティ値
subField
リッチ値に対してリッチ フィルターを実行するためにフィルターによって使用されるプロパティ。
subField?: string;
プロパティ値
string
values
フィルター処理の一部として使用する値のセット values
。
values?: Array<string | FilterDatetime>;
プロパティ値
Array<string | ExcelScript.FilterDatetime>
Office Scripts