ExcelScript.FilterCriteria interface

パッケージ:

ExcelScript

列に適用するフィルター条件を表します。

プロパティ

color	セルをフィルター処理するために使用する HTML カラー文字列。 フィルター処理とfontColor共にcellColor使用されます。
criterion1	データをフィルター処理するために使用する最初の条件。 フィルター処理の場合 custom の演算子として使用されます。 たとえば、50 を超える数値の場合は ">50"、"s" で終わる値の場合は "=*s" などです。 上位/下位項目/パーセントの場合の数値として使用されます (たとえば、上位 5 項目の場合は "5" が にtopItems設定されている場合filterOn)。
criterion2	データをフィルター処理するために使用する 2 番目の条件。 フィルター処理の場合 custom にのみ演算子として使用されます。
dynamicCriteria	この列に適用する ExcelScript.DynamicFilterCriteria セットの動的条件。 フィルター処理で dynamic 使用されます。
filterOn	値を表示する必要があるかどうかを判断するためにフィルターによって使用されるプロパティ。
icon	セルをフィルター処理するために使用するアイコン。 フィルター処理で icon 使用されます。
operator	フィルター処理を使用する場合に条件 1 と 2 を結合するために使用 custom される演算子。
subField	リッチ値に対してリッチ フィルターを実行するためにフィルターによって使用されるプロパティ。
values	フィルター処理の一部として使用する値の values セット。

プロパティの詳細

color

セルをフィルター処理するために使用する HTML カラー文字列。 フィルター処理とfontColor共にcellColor使用されます。

color?: string;

プロパティ値

string

criterion1

データをフィルター処理するために使用する最初の条件。 フィルター処理の場合 custom の演算子として使用されます。 たとえば、50 を超える数値の場合は ">50"、"s" で終わる値の場合は "=*s" などです。

上位/下位項目/パーセントの場合の数値として使用されます (たとえば、上位 5 項目の場合は "5" が にtopItems設定されている場合filterOn)。

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

例

/**
 * This script applies a filter to a table so that it only shows rows with "Needs Review" in the "Type" column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  const table = workbook.getTables()[0];

  // Apply the filter to the "Type" column.
  const typeColumn = table.getColumnByName("Type");
  typeColumn.getFilter().applyValuesFilter(["Needs Review"]);
}

dynamicCriteria

この列に適用する ExcelScript.DynamicFilterCriteria セットの動的条件。 フィルター処理で dynamic 使用されます。

dynamicCriteria?: DynamicFilterCriteria;

プロパティ値

ExcelScript.DynamicFilterCriteria

filterOn

値を表示する必要があるかどうかを判断するためにフィルターによって使用されるプロパティ。

filterOn: FilterOn;

プロパティ値

ExcelScript.FilterOn

icon

セルをフィルター処理するために使用するアイコン。 フィルター処理で icon 使用されます。

icon?: Icon;

プロパティ値

ExcelScript.Icon

operator

フィルター処理を使用する場合に条件 1 と 2 を結合するために使用 custom される演算子。

operator?: FilterOperator;

プロパティ値

ExcelScript.FilterOperator

subField

リッチ値に対してリッチ フィルターを実行するためにフィルターによって使用されるプロパティ。

subField?: string;

プロパティ値

string

values

フィルター処理の一部として使用する値の values セット。

values?: Array<string | FilterDatetime>;

プロパティ値

Array<string | ExcelScript.FilterDatetime>