Excel.Filter class

テーブルの列のフィルター処理を管理します。

注釈

使用元

Excel.TableColumn: フィルター

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
criteria	指定した列に現在適用されているフィルターです。

メソッド

apply(criteria)	指定の列に、指定したフィルター条件を適用します。
applyBottomItemsFilter(count)	指定した数の要素の列に "下位アイテム" フィルターを適用します。
applyBottomPercentFilter(percent)	指定した割合の要素の列に "下位パーセント" フィルターを適用します。
applyCellColorFilter(color)	指定した色の列に "セルの色" フィルターを適用します。
applyCustomFilter(criteria1, criteria2, oper)	指定した条件文字列の列に "アイコン" フィルターを適用します。
applyCustomFilter(criteria1, criteria2, oper)	指定した条件文字列の列に "アイコン" フィルターを適用します。
applyDynamicFilter(criteria)	列に "動的" フィルターを適用します。
applyDynamicFilter(criteria)	列に "動的" フィルターを適用します。
applyFontColorFilter(color)	指定した色の列に "フォントの色" フィルターを適用します。
applyIconFilter(icon)	指定されたアイコンの列に "アイコン" フィルターを適用します。
applyTopItemsFilter(count)	指定した数の要素の列に "上位アイテム" フィルターを適用します。
applyTopPercentFilter(percent)	指定した割合の要素の列に "上位パーセント" フィルターを適用します。
applyValuesFilter(values)	指定した値の列に "値" フィルターを適用します。
clear()	指定した列に適用されているフィルターをクリアします。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.Filter` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.FilterData` と型指定) を返します。

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

criteria

指定した列に現在適用されているフィルターです。

readonly criteria: Excel.FilterCriteria;

プロパティ値

Excel.FilterCriteria

注釈

API セット: ExcelApi 1.2

apply(criteria)

指定の列に、指定したフィルター条件を適用します。

apply(criteria: Excel.FilterCriteria): void;

パラメーター

criteria: Excel.FilterCriteria

適用する基準。

返品

void

注釈

API セット: ExcelApi 1.2

applyBottomItemsFilter(count)

指定した数の要素の列に "下位アイテム" フィルターを適用します。

applyBottomItemsFilter(count: number): void;

パラメーター

count: number

表示する下位からの要素の数。

返品

void

注釈

API セット: ExcelApi 1.2

applyBottomPercentFilter(percent)

指定した割合の要素の列に "下位パーセント" フィルターを適用します。

applyBottomPercentFilter(percent: number): void;

パラメーター

percent: number

表示する下位からの要素のパーセンテージ。

返品

void

注釈

API セット: ExcelApi 1.2

applyCellColorFilter(color)

指定した色の列に "セルの色" フィルターを適用します。

applyCellColorFilter(color: string): void;

パラメーター

color: string

表示するセルの背景色です。

返品

void

注釈

API セット: ExcelApi 1.2

applyCustomFilter(criteria1, criteria2, oper)

指定した条件文字列の列に "アイコン" フィルターを適用します。

applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;

パラメーター

criteria1: string

最初の条件の文字列です。

criteria2: string

省略可能。 2 つ目の条件の文字列です。

oper: Excel.FilterOperator

省略可能。 2 つの条件を結合する方法を記述する演算子です。

返品

void

注釈

API セット: ExcelApi 1.2

applyCustomFilter(criteria1, criteria2, oper)

指定した条件文字列の列に "アイコン" フィルターを適用します。

applyCustomFilter(criteria1: string, criteria2?: string, oper?: "And" | "Or"): void;

パラメーター

criteria1: string

最初の条件の文字列です。

criteria2: string

省略可能。 2 つ目の条件の文字列です。

oper: "And" | "Or"

省略可能。 2 つの条件を結合する方法を記述する演算子です。

返品

void

注釈

API セット: ExcelApi 1.2

applyDynamicFilter(criteria)

列に "動的" フィルターを適用します。

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

パラメーター

criteria: Excel.DynamicFilterCriteria

適用する動的条件。

返品

void

注釈

API セット: ExcelApi 1.2

applyDynamicFilter(criteria)

列に "動的" フィルターを適用します。

applyDynamicFilter(criteria: "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"): void;

パラメーター

criteria: "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"

適用する動的条件。

返品

void

注釈

API セット: ExcelApi 1.2

applyFontColorFilter(color)

指定した色の列に "フォントの色" フィルターを適用します。

applyFontColorFilter(color: string): void;

パラメーター

color: string

表示するセルのフォントの色です。

返品

void

注釈

API セット: ExcelApi 1.2

applyIconFilter(icon)

指定されたアイコンの列に "アイコン" フィルターを適用します。

applyIconFilter(icon: Excel.Icon): void;

パラメーター

icon: Excel.Icon

表示するセルのアイコンです。

返品

void

注釈

API セット: ExcelApi 1.2

applyTopItemsFilter(count)

指定した数の要素の列に "上位アイテム" フィルターを適用します。

applyTopItemsFilter(count: number): void;

パラメーター

count: number

表示する上位からの要素の数。

返品

void

注釈

API セット: ExcelApi 1.2

applyTopPercentFilter(percent)

指定した割合の要素の列に "上位パーセント" フィルターを適用します。

applyTopPercentFilter(percent: number): void;

パラメーター

percent: number

表示する上位からの要素のパーセンテージ。

返品

void

注釈

API セット: ExcelApi 1.2

applyValuesFilter(values)

指定した値の列に "値" フィルターを適用します。

applyValuesFilter(values: Array<string | FilterDatetime>): void;

パラメーター

values: Array<string | Excel.FilterDatetime>

表示する値のリスト。これは文字列の配列または Excel.FilterDateTime オブジェクトの配列である必要があります。

返品

void

注釈

API セット: ExcelApi 1.2

clear()

指定した列に適用されているフィルターをクリアします。

clear(): void;

返品

void

注釈

API セット: ExcelApi 1.2

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;

パラメーター

options: Excel.Interfaces.FilterLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Excel.Filter

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.Filter;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Excel.Filter

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Filter;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Excel.Filter

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Filter オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.FilterData と型指定) を返します。

toJSON(): Excel.Interfaces.FilterData;

返品

Excel.Interfaces.FilterData

注釈

使用元

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

criteria

プロパティ値

注釈

メソッドの詳細

apply(criteria)

パラメーター

返品

注釈

applyBottomItemsFilter(count)

パラメーター

返品

注釈

applyBottomPercentFilter(percent)

パラメーター

返品

注釈

applyCellColorFilter(color)

パラメーター

返品

注釈

applyCustomFilter(criteria1, criteria2, oper)

パラメーター

返品

注釈

applyCustomFilter(criteria1, criteria2, oper)

パラメーター

返品

注釈

applyDynamicFilter(criteria)

パラメーター

返品

注釈

applyDynamicFilter(criteria)

パラメーター

返品

注釈

applyFontColorFilter(color)

パラメーター

返品

注釈

applyIconFilter(icon)

パラメーター

返品

注釈

applyTopItemsFilter(count)

パラメーター

返品

注釈

applyTopPercentFilter(percent)

パラメーター

返品

注釈

applyValuesFilter(values)

パラメーター

返品

注釈

clear()

返品

注釈

load(options)

パラメーター

返品

load(propertyNames)

パラメーター

返品

load(propertyNamesAndPaths)

パラメーター

返品

toJSON()

返品

フィードバック