Excel.FilterCriteria interface

  • リファレンス
パッケージ:
excel

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

注釈

[ API セット: ExcelApi 1.2 ]

プロパティ

color

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

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

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

データをフィルター処理するために使用する 2 番目の条件。 フィルター処理の場合 custom にのみ演算子として使用されます。
dynamicCriteria

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

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

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

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

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

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

プロパティの詳細

color

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

color?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.2 ]

criterion1

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

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

criterion1?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.2 ]

criterion2

データをフィルター処理するために使用する 2 番目の条件。 フィルター処理の場合 custom にのみ演算子として使用されます。

criterion2?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.2 ]

dynamicCriteria

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

dynamicCriteria?: Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday";

プロパティ値

Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

注釈

[ API セット: ExcelApi 1.2 ]

filterOn

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

filterOn: Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom";

プロパティ値

Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom"

注釈

[ API セット: ExcelApi 1.2 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

icon

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

icon?: Excel.Icon;

プロパティ値

Excel.Icon

注釈

[ API セット: ExcelApi 1.2 ]

operator

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

operator?: Excel.FilterOperator | "And" | "Or";

プロパティ値

Excel.FilterOperator | "And" | "Or"

注釈

[ API セット: ExcelApi 1.2 ]

subField

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

subField?: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

values

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

values?: Array<string | FilterDatetime>;

プロパティ値

Array<string | Excel.FilterDatetime>

注釈

[ API セット: ExcelApi 1.2 ]